Skip to main content

Webhooks API

Manage signed webhook endpoints, delivery history, replay, and secret rotation.

Use This API To

  • List and create webhook endpoints.
  • Inspect delivery attempts and replay individual deliveries.
  • Rotate signing secrets for webhook endpoints.

Before You Call

1

Verify signatures on every inbound webhook

Verify signatures on every inbound webhook.
2

Use replay for idempotent recovery, not duplicate business actions

Use replay for idempotent recovery, not duplicate business actions.
3

Store webhook endpoint IDs and event IDs for debugging

Store webhook endpoint IDs and event IDs for debugging.

Endpoints

GET /v1/webhook_endpoints

List webhook endpoints for the current organization

POST /v1/webhook_endpoints

Create a signed webhook endpoint for artifact and stream events

GET /v1/webhook_endpoints/{webhook_id}/deliveries

List canonical delivery attempts for a webhook endpoint

POST /v1/webhook_endpoints/{webhook_id}/deliveries/{delivery_id}/replay

Replay a stored webhook delivery attempt by re-emitting its source event to the endpoint

POST /v1/webhook_endpoints/{webhook_id}/rotate_secret

Rotate the signing secret for a webhook endpoint