Get a webhook endpoint

GET

/v1/webhooks/{webhook_id}

const endpoint = await bird.webhooks.get("whk_01krdgeqcxet5s7t44vh8rt9mg");
console.log(endpoint.url, endpoint.events);

endpoint = client.webhooks.get("whk_01krdgeqcxet5s7t44vh8rt9mg")
print(endpoint.url, endpoint.events)

endpoint, err := client.Webhooks.Get(context.Background(), "whk_123")
if err != nil {
	log.Fatal(err)
}
fmt.Println(endpoint.Url)

$endpoint = $bird->webhooks->get('whk_01krdgeqcxet5s7t44vh8rt9mg');
echo $endpoint->getUrl();

bird webhooks get <webhook-id>

curl -X GET "https://us1.platform.bird.com/v1/webhooks/{webhook_id}" \
  -H "Authorization: Bearer $TOKEN"

Réponse200

{
  "id": "whk_01krdgeqcxet5s7t44vh8rt9mg",
  "url": "https://example.com/webhook",
  "description": "Production webhook endpoint",
  "events": [
    "email.delivered",
    "email.bounced"
  ],
  "status": "active",
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

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.

Paramètres

webhook_id

string

ID of the webhook endpoint (whk_ prefix), as returned when it was created.

Contenu de la réponse

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 where the API delivers events for this endpoint.

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. We keep 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

const endpoint = await bird.webhooks.get("whk_01krdgeqcxet5s7t44vh8rt9mg");
console.log(endpoint.url, endpoint.events);

endpoint = client.webhooks.get("whk_01krdgeqcxet5s7t44vh8rt9mg")
print(endpoint.url, endpoint.events)

endpoint, err := client.Webhooks.Get(context.Background(), "whk_123")
if err != nil {
	log.Fatal(err)
}
fmt.Println(endpoint.Url)

$endpoint = $bird->webhooks->get('whk_01krdgeqcxet5s7t44vh8rt9mg');
echo $endpoint->getUrl();

bird webhooks get <webhook-id>

curl -X GET "https://us1.platform.bird.com/v1/webhooks/{webhook_id}" \
  -H "Authorization: Bearer $TOKEN"

Réponse200

{
  "id": "whk_01krdgeqcxet5s7t44vh8rt9mg",
  "url": "https://example.com/webhook",
  "description": "Production webhook endpoint",
  "events": [
    "email.delivered",
    "email.bounced"
  ],
  "status": "active",
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}