Skip to main content
POST
Register or update webhook

Authorizations

Authorization
string
header
required

OAuth 2.1 with PKCE

Body

application/json
webhookUrl
string<uri>
required

Publicly accessible URL to receive POST notifications

webhookToken
string

Bearer token sent with webhook requests

deliveryContext
object

Platform-specific delivery context (e.g. channel, thread)

conversationSessionKey
string

Session key for threading notifications

sessionKey
string

Custom session key (defaults to rest-api:{accountId})

Response

Webhook registered

success
boolean
webhookUrl
string<uri>
hasSecret
boolean
hasDeliveryContext
boolean
conversationSessionKey
string