Skip to main content
POST
/
api
/
v2
/
webhooks
Register a webhook
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>"
}
'
{
  "data": {
    "webhook_id": "<string>",
    "posting_id": "<string>",
    "url": "<string>",
    "event_type": "<string>",
    "is_active": true,
    "created_at": 123,
    "updated_at": 123,
    "object": "webhook"
  },
  "meta": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.heymilo.ai/llms.txt

Use this file to discover all available pages before exploring further.

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
required

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

Successful Response

data
WebhookResponse · object
required

A webhook configuration.

meta
Meta · object

Optional metadata. Shape varies by endpoint.