Create a webhook endpoint Beta

Register an https URL to receive signed events

Beta. This endpoint is live for design partners, with keys that Dopl issues while the developer portal is being built.

POST /v1/webhook_endpoints

The answer holds secret. Store it now: it is shown again only when you rotate it. Each event is a POST signed with the Standard Webhooks scheme. Check it with dopl.webhooks.unwrap(rawBody, headers, { secret }). Any secret key of the project and environment.

Answer with any 2xx within 15 seconds. Otherwise Dopl tries again, on a one minute tick, after 5 seconds, 5 minutes, 30 minutes, 2 hours, 5 hours, 10 hours and 10 hours. After 8 tries the delivery is failed until you replay it. Dedupe on the webhook-id header.

Authorizations

Authorizationrequiredheaderstring

A project secret key (sk_test_… or sk_live_…) sent as Authorization: Bearer <key>. Server to server only.

Body

urlrequiredstring

An https URL on a public host, on port 443 or 8443.

descriptionstring | null

A label for you, up to 500 characters.

enabled_eventsstring[] | null

Event names to send, such as action.completed. Omit or null for every event, including new ones.

StatusBody
201WebhookEndpointWithSecret
400, 401, 403Error