Skip to main content
POST
Register a webhook

Authorizations

X-API-KEY
string
header
required

API key for authentication. Pass your key in the X-API-KEY header.

Headers

X-API-KEY
string | null
Authorization
string | null
X-Workspace-Id
string | null

Body

application/json

Request body for creating a webhook.

posting_id
string
required

ID of the posting this webhook is for.

Example:

"13D77095"

webhook_url
string
required

Destination URL for webhook delivery.

Example:

"https://webhook.site/test"

event_type
string
required

Type of event that triggers the webhook. Supported values: 'interview_started', 'interview_completed', 'report_available', 'candidate_shortlisted', 'candidate_rejected'.

Example:

"interview_completed"

Response

Successful Response

data
WebhookWithSecretResponse · object
required

Webhook response returned only at creation time, includes the signing secret.

meta
Meta · object | null

Optional metadata. Shape varies by endpoint.