Skip to main content
GET
Retrieve a webhook
Fetches one webhook. The signing secret is never returned by reads; it appears only in the Create response. Returns the webhook object.

Path parameters

string
required
The webhook’s id (UUID).

The webhook object

string
Unique identifier (UUID).
string
Target URL for deliveries.
string[]
Event types delivered to this webhook; ["*"] means the session.status_updated firehose.
string | null
Optional label.
boolean
When true, the webhook stays registered but receives no deliveries. Set manually via Update, or automatically after repeated delivery failures.
string | null
Result of the most recent delivery attempt: succeeded or failed. null before the first attempt.
string | null
What went wrong on the most recent delivery attempt, e.g. HTTP 503 or a connection error. null when it succeeded.
string | null
When the most recent delivery attempt happened (UTC). null before the first attempt.
string | null
When a delivery last succeeded (UTC). null if none has.
integer
Failed delivery attempts since the last success. Resets to 0 on a successful delivery or a manual re-enable; the webhook is disabled automatically when it grows too large. See Delivery semantics.
string
Creation time (UTC).
string
Last modification time (UTC).

Examples

Response

Errors