Skip to content

Create or update the events webhook configuration for the current account/environment.

PUT
/webhooks/events

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”

Request body for creating or updating the events webhook configuration.

object
webhook
required

Destination URL that receives webhook event payloads. Must be a valid http(s) URL.

string
events
required

List of event types that should be forwarded to the webhook URL.

Array<string>
Allowed values: EMAIL_OPEN EMAIL_CLICK EMAIL_FAILED EMAIL_DELIVERED EMAIL_UNSUBSCRIBE EMAIL_INBOUND INAPP_WEB_FAILED INAPP_WEB_UNSUBSCRIBE SMS_DELIVERED SMS_FAILED SMS_UNSUBSCRIBE SMS_INBOUND PUSH_FAILED PUSH_UNSUBSCRIBE CALL_FAILED CALL_UNSUBSCRIBE WEB_PUSH_FAILED WEB_PUSH_UNSUBSCRIBE SLACK_FAILED SLACK_UNSUBSCRIBE

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful response

Events webhook configuration returned by the API.

object
webhookId
required

Storage key in the format accountId:envId (currently accountId:accountId for account-scoped usage).

string
webhook
required

Destination URL that receives webhook event payloads.

string
events
required

List of subscribed event types for this webhook configuration.

Array<string>
Allowed values: EMAIL_OPEN EMAIL_CLICK EMAIL_FAILED EMAIL_DELIVERED EMAIL_UNSUBSCRIBE EMAIL_INBOUND INAPP_WEB_FAILED INAPP_WEB_UNSUBSCRIBE SMS_DELIVERED SMS_FAILED SMS_UNSUBSCRIBE SMS_INBOUND PUSH_FAILED PUSH_UNSUBSCRIBE CALL_FAILED CALL_UNSUBSCRIBE WEB_PUSH_FAILED WEB_PUSH_UNSUBSCRIBE SLACK_FAILED SLACK_UNSUBSCRIBE

400

Section titled “400 ”

Bad Request

401

Section titled “401 ”

Unauthorized

500

Section titled “500 ”

Internal Server Error