Skip to main content

Webhook Endpoint Reference

Every endpoint that manages an outbound webhook subscription, and what each one does. Reach for this page when you know what you want to do and need the call; the flow that uses them — subscribing, verifying signatures, testing, rotating, replaying — is in Webhooks & Event Delivery.

Subscription endpoints​

EndpointEffect
POST /webhooksCreate (returns secret once).
GET /webhooksList subscriptions in your organisation.
GET /webhooks/{id}Read one (does not return secret — only last four characters).
PATCH /webhooks/{id}Merge-patch update (URL, events, filters, custom headers, retry policy).
PUT /webhooks/{id}Replace (preserves secret).
DELETE /webhooks/{id}Soft-delete.
POST /webhooks/{id}/enableSet status to ACTIVE.
POST /webhooks/{id}/disableSet status to DISABLED.
POST /webhooks/{id}/rotateIssue a new signing secret.
POST /webhooks/{id}/pingFire a synthetic webhook.test event.
GET /webhooks/{id}/deliveriesDelivery history.
POST /webhooks/{id}/redriveReplay failed deliveries.
GET /webhooks/eventsLive event catalogue.

Replay lives on the recruitment-check resource rather than the webhook, because it re-emits an event rather than re-sending a delivery:

EndpointEffect
POST /recruitment-checks/{id}/replay-completionRe-emit one completion event. Writes nothing.
POST /recruitment-checks/replay-completionsThe same for an explicit list of ids. Dry run by default.

Every endpoint requires a Bearer token authorized for the webhook entity — see Authentication & Tokens.

Where to go next​