Create Subscription

Creates a webhook subscription for digital events. A subscription supports filtering of events by specifying an event type.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 6 and 6

The unique 6 character internal id that represents the customer account.

Body Params

Digital webhook subscription

string
required
length between 3 and 256

The unique id that represents the channel provider

string
required
length ≤ 2048

The public (https) url to send the callback payload.

eventTypes
array of objects
required
length between 1 and 6

The list of event types subscribed for:

eventTypes*

The type of digital event to subscribe for. The event types available are:

  • MESSAGES - A message sent either by customer or a contact center resource (agent, supervisor, system or bot)
  • CUSTOMER_MESSAGES - A message sent by customer
  • CC_MESSAGES - A message sent by a contact center resource (agent, supervisor, system or bot)
  • PARTICIPANT_ADDED - A participant added to an engagement
  • PARTICIPANT_DISCONNECTED - A participant disconnected an engagement
  • ENGAGEMENT_CREATED - A new engagement was created
  • ENGAGEMENT_ERROR - An error occurred in an engagement
  • TYPING - An indication that a Contact Center participant is typing. This event is only supported for Custom Messaging
  • ALL - An event belonging to any of the above types occurred. When you subscribe to ALL, you are effectively subscribing to all current event types, as well as any that might be introduced in the future. Therefore, it's crucial to ensure that your callback handler doesn't fail or return an error when receiving any new event type that you are not prepared to handle

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json