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 Apple Messages for Business, Facebook Messenger, MMS, SMS, Open Channel, Blocklist, and Mobile Identity 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.

Select the categories below to see which formats are available for selection.

ChannelsNumbers and sendersTools

Apple Messages for Business

Event	Format name	Format payload
Delivery	adaptive.subscription.format	Payload is picked based on the API used in your submission
	delivery.apple-messages-for-business.v3.json	AMB API: Receive AMB delivery reports (opens in a new tab)
	delivery.apple-messages-for-business.v4.json	Messages API: Receive delivery reports (opens in a new tab)
Inbound message	inbound-message.apple-messages-for-business.v1.json	AMB API: Receive incoming AMB messages (opens in a new tab)
	inbound-message.apple-messages-for-business.v2.json	Messages API: Receive inbound messages (opens in a new tab)

Facebook Messenger

Event	Format name	Format payload
Delivery	adaptive.subscription.format	Payload is picked based on the API used in your submission
	delivery.facebook.v5.json	Messages API: Receive delivery reports (opens in a new tab)
	delivery.facebook.v4.json	Messenger API: Receive Messenger delivery reports (opens in a new tab)
Inbound message	inbound-message.facebook.v1.json	Messenger API: Receive incoming Messenger messages (opens in a new tab)
	inbound-message.facebook.v2.json	Messages API: Receive inbound messages (opens in a new tab)
Marketing opt-in	marketing.facebook.v1.json	Messenger API: Receive Messenger opt-in marketing event (opens in a new tab)
Marketing opt-out	marketing.facebook.v1.json	Messenger API: Receive Messenger opt-out marketing event (opens in a new tab)

SMS

Event	Format name	Format payload
Click	tracking.sms.v1.json	SMS API: Receive SMS tracking notifications (opens in a new tab)
Delivery	adaptive.subscription.format	Payload is picked based on the API used in your submission
	delivery.sms.v2.json	Omni-failover API: Receive delivery status report (opens in a new tab)
	delivery.sms.v3.json	SMS API v2: Receive outbound SMS message report (opens in a new tab)
	delivery.sms.v4.json	SMS API v3: Receive outbound SMS message reports (opens in a new tab)
	delivery.sms.v5.json	Messages API: Receive delivery reports (opens in a new tab)
Inbound message	inbound-message.sms.v1.json	SMS API: Receive inbound SMS messages (opens in a new tab)
	inbound-message.sms.v2.json	Messages API: Receive inbound messages (opens in a new tab)

MMS

Event	Format name	Format payload
Click	tracking.mms.v1.json	MMS API: Receive MMS tracking notifications (opens in a new tab)
Delivery	adaptive.subscription.format	Payload is picked based on the API used in your submission
	delivery.mms.v1.json	MMS API v1: Receive outbound MMS message report (opens in a new tab)
	delivery.mms.v3.json	Messages API: Receive delivery reports (opens in a new tab)
	delivery.mms.v4.json	MMS API v2: Receive MMS delivery reports (opens in a new tab)
Inbound message	inbound-message.mms.v1.json	MMS API: Receive inbound MMS messages (opens in a new tab)
	inbound-message.mms.v2.json	Messages API: Receive inbound messages (opens in a new tab)

Open Channel

Event	Format name	Format payload
Delivery	event.open-channel.v1.json	Open Channel API: Receive Open Channel outbound message (opens in a new tab)

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"
  }
]