Update a webhook endpoint
/v1/webhooks/{webhook_id}const endpoint = await bird.webhooks.update("whk_01krdgeqcxet5s7t44vh8rt9mg", {
events: ["email.delivered"],
});
console.log(endpoint.events);endpoint = client.webhooks.update(
"whk_01krdgeqcxet5s7t44vh8rt9mg",
events=["email.delivered"],
)
print(endpoint.events)endpoint, err := client.Webhooks.Update(context.Background(), "whk_123", bird.WebhooksUpdateParams{
Events: []bird.WebhookEventType{"email.delivered"},
})
if err != nil {
log.Fatal(err)
}
fmt.Println(endpoint.Events)$endpoint = $bird->webhooks->update(
'whk_01krdgeqcxet5s7t44vh8rt9mg',
(new WebhookEndpointUpdate())->setEvents(['email.delivered']),
);
echo implode(',', $endpoint->getEvents() ?? []);bird webhooks update <webhook-id> \
--description 'Updated webhook endpoint' \
--events email.delivered \
--events email.bounced \
--events email.complained \
--status active \
--url https://example.com/webhookcurl -X PATCH "https://us1.platform.bird.com/v1/webhooks/{webhook_id}" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com/webhook",
"description": "Updated webhook endpoint",
"events": [
"email.delivered",
"email.bounced",
"email.complained"
],
"status": "active"
}'{
"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"
}
Updates the webhook endpoint. Only the fields you send change: events replaces the
whole subscription set, and status pauses or re-enables delivery.
The 200 response is the updated endpoint. Invalid input (a non-HTTPS or non-public
url, an event type outside the catalog) returns a 422.
Parameter
webhook_idstringID of the webhook endpoint (whk_ prefix), as returned when it was created.
Anfrage-Nutzlast
urlReplacement delivery URL. Same rules as at creation: HTTPS, at most 2048 characters, and the host must be publicly reachable (private, loopback, and link-local addresses return a 422). Omit to keep the current URL. A connector endpoint's URL comes from its connector and cannot be replaced: any value returns a 422.
descriptionHuman-readable label for this endpoint, up to 256 characters.
filterReplace the mailbox scope. Omit to keep it, or send null to include all resources. Scoped endpoints accept only email_mailbox events.
eventsReplaces all event subscriptions with this list. Omit to keep the current set. Types outside the event catalog return a 422.
destinationChanges to how deliveries are built, shaped as at creation. Only a connector destination takes connector; on any other endpoint it returns a 422. Omit to keep the destination.
Untergeordnete Parameter anzeigen
destination.typeHow deliveries to the webhook endpoint are built: webhook posts the signed event unchanged to the endpoint URL; connector builds the delivery using the configured connector action. An existing endpoint's type cannot change; a different value returns a 422.
Possible values: webhook, connector
destination.connectorChanges to the endpoint's connector, nested as on creation. A field the endpoint's URL is built from moves the URL with it. New deliveries are prepared with the current config. Queued deliveries keep their prepared body, but every send attempt, including retries, uses the current destination URL and credentials.
Untergeordnete Parameter anzeigen
destination.connector.connector_idThe endpoint's connector. It cannot change, so a different value returns a 422.
destination.connector.actionThe endpoint's action. It cannot change, so a different value returns a 422.
destination.connector.credentialsNew values for the connector's secret fields, merged over the stored ones: a key given replaces that field and an omitted key keeps its value. The next delivery, retries included, uses them.
destination.connector.configChanges to the connector's nonsecret fields, keyed by field name. A key given replaces that field, null clears an optional one, and a key left out keeps its stored value. A required field cannot be cleared, and the result is checked as at creation.
statuspaused stops all deliveries; active re-enables a paused endpoint. Omit to leave the status unchanged. Events that fire while paused are not delivered and a replay cannot recover them, because they were never attempted; after re-enabling, Replay failed deliveries reaches only the deliveries that failed before the pause. A degraded endpoint cannot be reset through this field: it returns to active automatically once deliveries succeed again.
Possible values: active, paused
Antwort-Payload
idUnique identifier for the endpoint (whk_ prefix). Accepted as webhook_id by every /v1/webhooks/{webhook_id} operation.
urlHTTPS URL where the API delivers events for this endpoint.
descriptionHuman-readable label for the endpoint.
filterMailbox scope configured through filter, or null.
eventsEvent types this endpoint is subscribed to; only matching events are delivered. Change the set with Update a webhook endpoint.
statusDelivery 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 toactiveautomatically once deliveries succeed again.paused: All delivery is stopped, either because an update setstatustopausedor 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
created_atupdated_atVerwandte Ressourcen
Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.