Get a webhook endpoint
GET
/v1/webhooks/{webhook_id}
curl -X GET "https://us1.platform.bird.com/v1/webhooks/{webhook_id}" \
-H "Authorization: Bearer $TOKEN"Returns one webhook endpoint's configuration and current delivery status, including its URL and subscribed event types. The signing secret is never included; if you lost it, mint a new one with Rotate webhook signing secret.
Contenu de la réponse
id
string
obligatoire
Unique identifier for the endpoint (whk_ prefix). Accepted as webhook_id by every /v1/webhooks/{webhook_id} operation.
url
string
obligatoire
HTTPS URL Bird delivers this endpoint's events to.
description
string
Human-readable label for the endpoint.
events
array of string
obligatoire
Event types this endpoint is subscribed to; only matching events are delivered. Change the set with Update a webhook endpoint.
status
string
obligatoire
Delivery state of the endpoint.
- active: the initial state; events are being delivered normally.
- degraded: recent deliveries are failing. Bird keeps delivering and retrying, and the endpoint returns to active automatically once deliveries succeed again.
- paused: all delivery is stopped, either because an update set status to paused or automatically after sustained delivery failures. A paused endpoint never resumes on its own: re-enable it with Update a webhook endpoint, then recover the missed events with Replay missed events.
Possible values: active, degraded, paused
created_at
string
obligatoire
updated_at
string
obligatoire