Register a webhook

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

POST /api/v2/webhooks

Register a webhook

cURL

curl --request POST \
  --url https://api.heymilo.ai/api/v2/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "posting_id": "<string>",
  "url": "<string>",
  "event_type": "<string>"
}
'

201

{
  "data": {
    "webhook_id": "<string>",
    "posting_id": "<string>",
    "url": "<string>",
    "event_type": "<string>",
    "is_active": true,
    "created_at": 123,
    "updated_at": 123,
    "object": "webhook"
  },
  "meta": {}
}

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"

url · string · required

Destination URL for webhook delivery.

Example:

"https://webhook.site/test"

event_type · string · required

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

Example:

"interview_completed"

Response

201

application/json

Successful Response

data · WebhookResponse · object · required

A webhook configuration.

Show child attributes

meta · Meta · object

Optional metadata. Shape varies by endpoint.