Skip to main content
POST
Create subscription

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Path Parameters

channel
enum<string>
required

Channel name. A separate subscription is needed for each channel.

Available options:
AGENT_OS,
APPLE_MESSAGES_FOR_BUSINESS,
BLOCKLIST,
CUSTOMER_ENGAGEMENT,
EMAIL,
FACEBOOK,
KAKAO_ALIM,
KAKAO_BRAND_MESSAGE,
LINE,
MMS,
MOBILE_IDENTITY,
MOBILE_PUSH,
NUMBER_LOOKUP,
OPEN_CHANNEL,
RCS,
REGISTRATION,
SMS,
VIBER,
VOICE_VIDEO,
WEB_PUSH,
WHATSAPP,
ZALO

Body

application/json

Subscription group.

subscriptionId
string
required

Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.

Required string length: 1 - 255
events
enum<string>[]
required

List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the availability table. If configuring inbound Subscription, check inbound message configuration docs.

Maximum array length: 255
Available options:
CONVERSATION_AGENT_STATUS_UPDATED,
CONVERSATION_ASSIGNMENT_UPDATED,
CONVERSATION_CREATED,
CONVERSATION_CUSTOMER_UPDATED,
CONVERSATION_FORM_FIELD_UPDATED,
CONVERSATION_FORM_UPDATED,
CONVERSATION_MESSAGE_DELETED,
CONVERSATION_MESSAGE_RECEIVED,
CONVERSATION_MESSAGE_SENT,
CONVERSATION_MESSAGE_UPDATED,
CONVERSATION_NOTE_ADDED,
CONVERSATION_NOTE_REMOVED,
CONVERSATION_NOTE_UPDATED,
CONVERSATION_PRIORITY_UPDATED,
CONVERSATION_QUEUE_UPDATED,
CONVERSATION_SLA_POLICY_UPDATED,
CONVERSATION_STATUS_UPDATED,
CONVERSATION_SUMMARY_UPDATED,
CONVERSATION_TAG_ADDED,
CONVERSATION_TAG_REMOVED,
CONVERSATION_TOPIC_UPDATED,
MOBILE_APP_APP_LAUNCH,
MOBILE_APP_DEPERSONALIZE,
MOBILE_APP_INSTALL,
MOBILE_APP_PERSONALIZE,
MOBILE_APP_UNINSTALL,
PEOPLE_CUSTOM_AND_TEMPLATE_EVENTS,
PERSON_ATTRIBUTE_CHANGED,
PERSON_CONTACT_INFORMATION_CREATED,
PERSON_CONTACT_INFORMATION_DELETED,
PERSON_CONTACT_INFORMATION_UPDATED,
PERSON_CREATED,
PERSON_DELETED,
PERSON_MERGED,
PERSON_TAG_ADDED,
PERSON_TAG_DELETED,
WEB_SDK_PAGE_VIEW,
WEB_SDK_SESSION_ENDED,
WEB_SDK_SESSION_STARTED
profile
Profile · object
required

Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties.

name
string

A human-readable description for your subscription, can be changed at a later point.

Required string length: 1 - 255
subscriptionGroupId
string

Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery.

Maximum string length: 255
criteria
ApplicationEntityPair · object[]

Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.

Maximum array length: 255
resources
string[]

List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.

Maximum array length: 255

List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.

Maximum string length: 255
users
string[]

List of users to match. You can provide usernames from your account.

Maximum array length: 255

List of users to match. You can provide usernames from your account.

Maximum string length: 255
keywords
string[]

List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword.

Maximum array length: 255

List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword.

Maximum string length: 50

Response

Created.

Subscription group.

subscriptionId
string

Subscription ID.

profile
Profile · object

Notification profile.