Skip to main content
POST
/
campaigns
/
{campaignId}
/
webhook
/
subscribe
Subscribe a Webhook
curl --request POST \
  --url https://api.callers.ai/campaigns/{campaignId}/webhook/subscribe \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "name": "<string>",
  "events": [
    "POST_PROCESSING_FINISHED:INTERESTED",
    "POST_PROCESSING_FINISHED:NOT_INTERESTED",
    "POST_PROCESSING_FINISHED:CALL_ME_LATER",
    "POST_PROCESSING_FINISHED:WRONG_NUMBER",
    "POST_PROCESSING_FINISHED:DO_NOT_CALL"
  ],
  "isAdvanced": false,
  "advancedWebhook": {
    "url": "<string>",
    "method": "GET",
    "headers": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "parameters": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "body": ""
  }
}
'
{
  "status": "success",
  "data": true
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

Headers

​
x-sub-organization-id
string

Optional sub organization ID. Must belong to your main organization API key.

Path Parameters

​
campaignId
string
required

The campaign ObjectId as a string.

Body

application/json
​
url
string
required
​
name
string
Maximum string length: 30
​
events
enum<string>[]
Available options:
POST_PROCESSING_FINISHED:INTERESTED,
POST_PROCESSING_FINISHED:NOT_INTERESTED,
POST_PROCESSING_FINISHED:CALL_ME_LATER,
POST_PROCESSING_FINISHED:WRONG_NUMBER,
POST_PROCESSING_FINISHED:DO_NOT_CALL,
POST_PROCESSING_FINISHED:VOICE_MAIL,
FORWARDED_CALL_FINISHED,
FORWARDED,
HANG_UP,
DIALING,
CONNECTED,
FAILED,
COULD_NOT_CONNECT:NO_ANSWER,
COULD_NOT_CONNECT:BUSY,
CALL_FINISHED
​
isAdvanced
boolean
default:false
​
advancedWebhook
object

Response

​
status
enum<string>
Available options:
success
​
data
boolean