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

Response

200 - application/json

Webhook created successfully

The response is of type object.