Skip to main content
POST
Create a webhook subscription

Authorizations

Authorization
string
header
required

Server-side tenant-scoped credential created from Build > API Keys.

Body

application/json
url
string<uri>
required
Maximum string length: 2048
events
enum<string>[]
required
Required array length: 1 - 5 elements
Available options:
message.created,
message.delivery.updated,
conversation.handoff.updated,
crm.opportunity.created,
crm.opportunity.updated

Response

Success

webhook
object
secret
string

Returned once. Store securely.