Sign in

v1

latestOpenAPI 3.1.02026-08-0456127224.3 KB
Webhooks

Register a webhook

Register a webhook URL to receive event notifications. Events include candidate completion, interview status changes, etc.

post/api/v2/webhooks

Headers

X-API-KEYstring nullable
Authorizationstring nullable
X-Workspace-Idstring nullable

Request body

posting_idstring required

ID of the posting this webhook is for.

webhook_urlstring required

Destination URL for webhook delivery.

event_typestring required

Type of event that triggers the webhook: 'interview_completed', 'candidate_ingested', etc.

Example request

{
  "posting_id": "13D77095",
  "webhook_url": "https://webhook.site/test",
  "event_type": "interview_completed"
}

Response

Successful Response

metaobject nullable

Optional metadata. Shape varies by endpoint.

Example response

{
  "data": {
    "webhook_id": "42AE4CFA720B1C35D499E9E39C14F321",
    "posting_id": "13D77095",
    "webhook_url": "https://webhook.site/test",
    "event_type": "interview_completed",
    "created_at": 1739612400,
    "updated_at": 1739617200
  }
}