POST
/
modules
/
webhook
curl --request POST \
  --url http://sandbox.mintlify.com/modules/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "event_type": "call.started",
  "settings": {
    "method": "GET",
    "url": "<string>",
    "headers": {},
    "timeout": 123,
    "retry_limit": 123
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "event_type": "<string>",
  "status": "active",
  "settings": {
    "method": "GET",
    "url": "<string>",
    "headers": {},
    "timeout": 123,
    "retry_limit": 123
  }
}

The Webhook module allows you to integrate your campaigns with external systems by sending real-time event notifications.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
event_type
enum<string>
required
Available options:
call.started,
call.ended,
call.failed,
call.voicemail_detected,
conversation.transcript,
conversation.intent_detected,
conversation.entity_captured,
campaign.started,
campaign.paused,
campaign.completed,
campaign.quota_reached
​
settings
object
required

Response

200 - application/json
Webhook created successfully
​
id
string
​
event_type
string
​
status
enum<string>
Available options:
active,
paused,
error
​
settings
any

Was this page helpful?