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",
  "filter": null,
  "events": [
    "email.delivered",
    "email.bounced"
  ],
  "status": "active",
  "destination": {
    "type": "webhook"
  },
  "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_idstring

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

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

description

string

Human-readable label for the endpoint.

filter

nullable object

obligatoire

Mailbox scope configured through filter, or null.

Afficher les attributs enfants

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 Replay failed deliveries to recover the deliveries that failed before the pause. Events that arrived while it was paused were never attempted, so a replay does not reach them.

Possible values: active, degraded, paused

destination

object

How each delivery to the endpoint is built.

Afficher les attributs enfants

created_at

string

obligatoire

updated_at

string

obligatoire

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Essayez la pratique et obtenez un guide d'implémentation

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",
  "filter": null,
  "events": [
    "email.delivered",
    "email.bounced"
  ],
  "status": "active",
  "destination": {
    "type": "webhook"
  },
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

Get a webhook endpoint

Paramètres

Contenu de la réponse

Ressources associées