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"

Reactie200

{
  "id": "whk_01krdgeqcxet5s7t44vh8rt9mg",
  "url": "https://example.com/webhook",
  "description": "Production webhook endpoint",
  "filter": null,
  "events": [
    "email.delivered",
    "email.bounced"
  ],
  "status": "active",
  "destination": {
    "type": "webhook"
  },
  "next": [
    {
      "kind": "operation"
    }
  ],
  "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.

Parameters

webhook_idstring

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

Response Payload

id

string

verplicht

Unique identifier for the endpoint (whk_ prefix). Accepted as webhook_id by every /v1/webhooks/{webhook_id} operation.

url

string

verplicht

HTTPS URL where the API delivers events for this endpoint.

description

string

Human-readable label for the endpoint.

filter

nullable object

verplicht

Mailbox scope configured through filter, or null.

Onderliggende attributen tonen

events

array of string

verplicht

Event types this endpoint is subscribed to; only matching events are delivered. Change the set with Update a webhook endpoint.

status

string

verplicht

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.

Onderliggende attributen tonen

next

array of object

What to do next with this endpoint. The responses that create or update a connector endpoint suggest testing it, which checks its fields with the connected platform. Other responses that return one endpoint return an empty list, and lists omit it.

Onderliggende attributen tonen

next.kind

string

verplicht

What you do about this step.

operation: call the operation named in operation, then read again.
external: act somewhere this API does not reach, then read again.
wait: nothing is asked of you, so read again later.
terminal: nothing you do resolves this, so stop retrying.

Tolerate a value you do not recognize: show the description and offer no action.

Possible values (may grow over time): operation, external, wait, terminal

next.description

string

verplicht

A short, human-readable label for the step, suitable for display.

next.operation

string

The operationId to call. Present only when kind is operation. The operation's own schema says how to call it; this says only which one, and what to address it with.

next.params

object

The parameters that address the operation, by name: {"sender_id": "…"} for an operation on /v1/sms/senders/{sender_id}/requirements. A parameter the operation takes in its query string is given the same way, so an operation addressed as ?subject_id= carries {"subject_id": "…"}. Every parameter the call needs is here, whether its value came from the thing you were acting on or is fixed for this step, so you can make the call from this object alone. Present only when kind is operation and the operation names a subject. A request body, when the operation takes one, is described by the operation's own schema and never appears here.

next.url

string

A URL to open. Present only when kind is external, and only when the step has one. An external step whose description says to go and do something with no URL to open is normal.

created_at

string

verplicht

updated_at

string

verplicht

Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.

Probeer de oefening en ontvang een implementatieoverzicht

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"

Reactie200

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

Get a webhook endpoint

Parameters

Response Payload

Gerelateerde bronnen