Create Subscription

post

{protocol}://{server}/api/digital/webhook/v1beta/accounts/{accountId}/subscriptions

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

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

Body Params

Digital webhook subscription

channelProviderId

string

required

length between 3 and 256

The unique id that represents the channel provider

callbackUrl

string

required

length ≤ 2048

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

eventTypes

array of objects

required

length between 1 and 5

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
ALL - An event belonging to any of the above types occurred

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Callback

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

201Created

400Bad Request

401Unauthorized.

403Forbidden.

404Not Found.

500Internal Server Error