Skip to main content
POST
Subscribe a Webhook

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