Version

Webhook Endpoints API

A webhook endpoint is a URL of yours that Subscriby posts events to, with the event families it subscribes to and a signing secret you verify each delivery against.

A webhook endpoint is a URL of yours that Subscriby posts events to, with the event families it subscribes to and a signing secret you verify each delivery against. An endpoint belongs to the team and may be narrowed to one project; the secret is shown exactly twice, in the answer to registering the endpoint and in the answer to rotating it, and never appears on a read.

Each endpoint carries its delivery health: the last success and failure, and disabled_at when Subscriby switched it off after too many consecutive failures or when someone paused it. Pause and resume are the dashboard's on/off switch, and events raised while paused are not queued or replayed; test enqueues a synthetic delivery so a new handler can be checked before real traffic; rotate secret revokes the old secret at once, so deploy the new one first. The delivery log and the replay of a dead-lettered row live under webhook deliveries.

Every member of the team may list and read endpoints, but only the member who registered one, or the team owner, may rotate, test, pause, resume or delete it. The same routes answer under the /v1/webhook-subscriptions alias so Zapier's subscribe and unsubscribe hooks can target them directly. Endpoint lifecycle emits no webhooks of its own, since that would be recursive.

Background

The webhook-subscriptions alias

GET, POST /v1/webhook-subscriptions and DELETE /v1/webhook-subscriptions/{endpoint} are 1:1 aliases of the list, create and delete endpoints below, so Zapier's subscribe and unsubscribe hooks can target them directly. They take the same abilities, bodies and answers and are not listed separately. The retired umbrella ability webhook-endpoint:manage still satisfies every route here on tokens that carry it; new tokens take the per-verb abilities.

Who may change an endpoint

Every member of the team can list and read the team's endpoints, but only the member who registered an endpoint, or the team owner, may rotate its secret, test it, pause or resume it, or delete it. A token minted by another member receives 403 FORBIDDEN on those calls; an endpoint outside the token's team is a 404 RESOURCE_NOT_FOUND, never a 403, so an id cannot be probed.

Endpoints

How is this guide?

Last updated on

Version

On this page

Subscriby is a product
designed by you — for you.
No boardroom full of executives deciding what we ships next. Our roadmap always shaped by you with your feedback.

Share feedback or a request

For AI agents: llms.txt · llms-full.txt