v1

latestOpenAPI 3.0.32026-08-06128539552.6 KB
Webhooks

Create Webhook Subscription

Create a Webhook Subscription.

post/beta/webhooks

Request body

namestring required

The Webhook Subscription name

eventsstring[]

The set of events this Webhook Subscription subscribes to. Allowed values: [SLAEvaluationVoided, ConversationPending, SLAEvaluationBreached, ConversationMessageAdded, ConversationCustomAttributeUpdated, SLAEvaluationAchieved, ConversationAssigned, ConversationMessageDeliveryDelivered, ConversationMessageDeliveryInfo, ConversationTransferred, ConversationEnqueued, AgentUnbannedEnduser, TypingStarted, ConversationCreated, ConversationUnassigned, ConversationOpen, ConversationAbandoned, ConversationClosed, ConversationMessageDeliveryFailed, ConversationTagAdded, ConversationNoteAdded, AgentBannedEnduser, ConversationEndUserReplaced, ConversationMessageDeliverySeen, AgentUnbannedIp, ConversationMessageDeliverySent, AgentBannedIp, ConversationTagRemoved, ConversationRated, SLAEvaluationPending, ConversationMessageDeliverySpamComplaint, ConversationPendingExpired]

urlstring required

URL of the server that the webhook request should be sent to

customHeadersMapString required
enabledboolean

Defines whether this Webhook Subscription is enabled or disabled. Default is true

filtersMapWebhookEventTypeFilters

Response

The created Webhook Subscription