Event format assignment

Event format assignment defines how inbound messages are structured and delivered to your webhook.

Each subscription automatically receives a default format, which is channel-specific to ensure consistent processing. If the default format does not meet your requirements, you can select another supported format for available channels. This allows you to control the payload structure that is sent to your webhook.

Default formats by channel

Each subscription automatically assigns a default format for handling inbound messages. These formats are channel-specific to ensure consistent processing of inbound messages.

Supported channels use the following predefined JSON-based formats to structure and process inbound messages:

Selectable event formats

Use event formats to choose the payload in which you want to receive events to your webhook.

Event formats are currently available for selection for SMS and MMS channel events. If you need to change the format for other channels or events, contact Support.

You can choose between two options:

• Static formats: Fixed payload schema that corresponds to a specific API version (for example, SMS API v3 or MMS API v1). All events of that type are delivered in the selected schema, regardless of how the original message was sent.
• Adaptive subscription format: Dynamic schema where the system delivers the payload that matches the API you used to send the original message.

How to select a different format

You can select a different format when creating or editing a subscription.

Web interface

1. Log in (opens in a new tab) and go to Developer Tools > Subscriptions Management.
2. Find your SMS or MMS subscription in the list.
3. Open the three-dot menu next to the subscription name and select Edit.
4. On the Select events screen, choose your preferred event format from the dropdown.
5. Save your subscription to apply the new settings.

API

You can configure event formats when creating (opens in a new tab) or updating (opens in a new tab) a subscription by including the format field in the events object.

Example without a format (default will be applied):

"events": [
  "DELIVERY"
]

Example with a selected format:

"events": [
  {
    "event": "DELIVERY",
    "format": "delivery.sms.v3.json"
  }
]