Be notified when a message has failed to be sent to your recipient
Event
| Event Name | Description |
|---|---|
| Failed | Triggered when the message has failed to be processed/delivered. |
Payload Samples
//Sample response for a failed message
{
"specversion": "1.0",
"type": "com.interact.messages.sms.status",
"source": "https://api.webexinteract.com/v1/sms",
"id": "evt_2z020YIp98J0ow5egHEVQJQd2Sx",
"time": "2025-06-25T12:10:47Z",
"datacontenttype": "application/json",
"data": {
"status": "failed",
"channel": "sms",
"phone_number": "+447810000001",
"from": "Name",
"message_body": "This is your message",
"message_parts": "1",
"scheduled_at": "2025-06-30T12:08:43Z",
"list_id": "18920476",
"custom_id": "123",
"campaign_name": "Some campaign",
"campaign_id": "cmp_214r8u4981u498"
},
"correlation_id": "anexternallyassignedreference",
"transaction_id": "tid_35T5b3cQmfqTu6jcedrdVcSmNHr"
Field Definitions
| Parameter | Show/Hide | Description |
|---|---|---|
| type | Always shown | Specifies the event type. |
| source | Always shown | Indicates the event's origin, such as the API URL.. |
| id | Always shown | Unique webhook event identifier. |
| time | Always shown | Timestamp (ISO 8601 format) of the event. |
| datacontenttype | Always shown | Specifies the data format, typically "application/json". |
| → status | Always shown | SMS message status (submitted, delivered, failed, clicked). |
| → channel | Always shown | Specifies channel used to send the message |
| →from | Always shown | Recipient phone number. |
| →message_body | Always shown | The message to be sent to the recipient. |
| →message_parts | Always shown | The number of SMS being sent in the message. |
| →scheduled_at | Shown if message was scheduled | The date time that the message is scheduled for. |
| →list_id | Shown if the receipient was part of a target list | The list_id of the targeted list. |
| →campaign_name | Shown if message was sent as part of a Campaign | If the message was requested as part of a campaign then the campaign name is provided. |
| →campaign_id | Shown if message was sent as part of a Campaign | If the message was requested as part of a campaign then the campaign ID is provided. |
| correlation_id | API: Shown if provided on SMS request Campaigns: Always shown | API SMS Requests: A reference that was set on the request. Campaigns: Automatically generated. |
| transaction_id | Always shown | A unique identifier internally generated for the associated SMS request. |