Skip to main content
PUT
Update the webhook configuration

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-company-id
string

Target company identifier. Required only for global API keys (type=global). Ignored for company API keys and human users.

Path Parameters

id
string
required

Body

application/json
url
string<uri>

Webhook URL to receive events

events
enum<string>[]

List of events that will trigger the webhook

Minimum array length: 1
Available options:
MESSAGE_SENT,
MESSAGE_RECEIVED,
MESSAGE_DELIVERED,
MESSAGE_READ,
CONVERSATION_UPDATED,
CONVERSATION_CREATED,
FOLLOWUP_SENT,
FIELD_UPDATED,
CONTACT_CREATED,
CONTACT_UPDATED
custom_headers
object

Custom headers to send along with the webhook

status
enum<string>

Webhook status (ACTIVE or INACTIVE)

Available options:
ACTIVE,
INACTIVE

Response

200 - application/json
_id
object
required
company
object
required
url
string
required
events
enum<string>[]
required
Available options:
MESSAGE_SENT,
MESSAGE_RECEIVED,
MESSAGE_DELIVERED,
MESSAGE_READ,
CONVERSATION_UPDATED,
CONVERSATION_CREATED,
FOLLOWUP_SENT,
FIELD_UPDATED,
CONTACT_CREATED,
CONTACT_UPDATED
custom_headers
object
required
status
enum<string>
required
Available options:
ACTIVE,
INACTIVE
createdAt
string<date-time>
updatedAt
string<date-time>