All messages sent via the Omnichannel API can provide message status webhook events. You can subscribe your webhook to receive these events to understand the status of your message sends, but only subscribe to the message events you need to avoid overheads.

The message events themselves are usually used to understand the status of a message with additional detail contained within the events payload, if required. A message can generate the following message events:

So in a typical message send you could receive the following webhook events:

message.sent or message.sentRequest - Your message has been sent on the channel
Once the final status is known you will receive on of the following events:
- message.delivered - Your message has been delivered
- message.read - Your message has been read/opened (On channels that support it)
- message.expired - Your message wasn't delivered within the expiresOn time window, or the channels default time window
- message.failed - The message failed to be delivered

If you have used trackable interactions in your message then you can receive an interaction.click event when they are interacted with. This is supported for:

Links in transactional emails
Shortened links in SMS

More details on the message webhook events, their schema and examples can be found below:

📘
Additional channel specific guidance
For additional information about channel specific data contained in the webhooks please see the Receipts and Inbounds section in the relevant channel guide

Sent

This event indicates a message has been sent on a channel.

Examples

{
  "eventId": "0dceaf0d-93ea-4314-a6f8-b0cffe69799a",
  "accountId": 1234,
  "apiSpaceId": "c924cf6e-4352-4b26-a71a-c2032bea7a01",
  "name": "message.sent",
  "payload": {
    "details": {
      "channel": "sms",
      "additionalInfo": {
        "to": "447123123123",
        "successful": true,
        "clientRef": "e9f154c8-4011-493f-bb73-09cfcf8a1411"
      },
      "channelStatus": {
        "sms": {
          "status": "sent",
          "details": {
            "to": "447123123123",
            "successful": true,
            "clientRef": "e9f154c8-4011-493f-bb73-09cfcf8a1411"
          },
          "updatedOn": "2017-08-31T09:26:14.798Z"
        }
      }
    },
    "channelData": {
      "sms": {
        "phoneNumberCountryCode": "GB",
        "segmentCount": 1
      }
    },
    "updatedOn": "2017-08-31T09:26:14.799Z",
    "metadata": {
      "data": "My correlation data"
    },
    "id": "e9f154c8-4011-493f-bb73-09cfcf8a1411"
  },
  "revision": 2,
  "etag": "\"2e-PLB2C6w/yVdPjUhuRiZtlvt8k0Q\"",
  "timestamp": "2017-08-31T09:26:14.604Z"
}

{
    "eventId": "1ba527cf-61fc-485d-8e13-bd4b033d9be9",
    "accountId": 1234,
    "apiSpaceId": "1154802b-a288-48f9-839c-b56181b9f3cf",
    "name": "message.sent",
    "payload": {
        "id": "b960fa14-9f39-412a-b46f-e073f18e7199",
        "details": {
            "channel": "mms",
            "additionalInfo": {
                "to": "17123123123",
                "successful": true,
                "segmentCount": 1
            },
            "channelStatus": {
                "mms": {
                    "status": "sent",
                    "updatedOn": "2024-01-12T13:49:38.021Z",
                    "details": {
                        "to": "17123123123",
                        "successful": true,
                        "segmentCount": 1
                    }
                }
            }
        },
        "metadata": {
            "useraccountid": 1234,
            "campaignid": 1518,
            "campaignname": "Test",
            "contactid": 111111,
            "requestid": 0,
            "sendid": 0,
            "programid": 0
        },
        "updatedOn": "2024-01-12T13:49:36.829Z",
        "channelData": {
            "mms": {
                "fromPhoneNumber": "1321321321",
                "phoneNumberCountryCode": "US",
                "segmentCount": 1
            }
        }
    },
    "revision": 2,
    "etag": "\"2e-/M/cPyS542jB+raFJkj8qCUpiTY\"",
    "timestamp": "2024-01-12T13:49:38.034Z"
}

{
  "eventId": "1faac58f-1f34-4892-82ff-82534231cd61",
  "name": "message.sent",
  "revision": 1,
  "apiSpaceId": "1344aba6-a68d-4ebe-9010-5437e7ba3b25",
  "accountId": 123,
  "etag": "\"3e-tljc/YvSoeI3vXB/8x6bpMshwKI\"",
  "payload": {
    "details": {
      "channel": "transactionalEmail",
      "channelStatus": {
        "transactionalEmail": {
          "status": "sent",
          "updatedOn": "2022-04-04T09:42:19.200Z",
          "details": {
            "toAddresses": "joe.bloggs@emailsim.io,jo.bloggs@acme.com",
            "ccAddresses": null,
            "bccAddresses": null,
            "campaignId": 321,
            "campaignTags": [
              "registration",
              "transactional"
            ]
          }
        }
      },
      "updatedOn": "2021-10-04T11:03:57.930Z",
      "metadata": {
        "myIdentifier": "abc5",
        "customField": "A value"
      },
      "id": "56c8e86f-2677-403c-8a6c-4dab31a24dc7"
    },
    "timestamp": "2021-10-04T11:03:57.930Z"
  }
}

{
  "eventId": "e0c3111b-d3a2-4042-96da-c92dfc7e1c52",
  "accountId": 1234,
  "apiSpaceId": "fe42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.sent",
  "payload": {
    "id": "89a31d97-b23e-41db-be4c-087df2136bd0",
    "details": {
      "channel": "rcs",
      "additionalInfo": {
        "name": "phones/+4477123123123/agentMessages/89a31d97-b23e-41db-be4c-087df2136bd0",
        "sendTime": "2019-10-23T16:03:33.677Z",
        "contentMessage": {
          "text": "Sending is easy with Omnichannel API"
        }
      },
      "channelStatus": {}
    },
    "metadata": {
      "data": "My important data"
    },
    "updatedOn": "2019-10-23T16:03:32.468Z",
    "channelData": {
      "rcs": {
        "phoneNumber": "447123123123",
        "phoneNumberCountryCode": "GB",
        "agentId": "770950354877"
      }
    }
  },
  "revision": 2,
  "etag": "\"2e-7gE/WwkZra5g83pnw9iaeuI/NJw\"",
  "timestamp": "2019-10-23T16:03:33.697Z"
}

{
    "eventId": "f10fd498-1f96-4f3b-a0f8-289e34928e15",
    "accountId": 12345,
    "apiSpaceId": "62d1780d-8440-480a-b268-20b1eb50a4ff",
    "name": "message.sent",
    "payload": {
        "id": "c94a82da-55e8-4a29-922c-ba4aed3e5990",
        "details": {
            "channel": "whatsApp",
            "channelStatus": {
                "whatsApp": {
                    "status": "sent",
                    "updatedOn": "2024-10-29T10:08:59.000Z",
                    "details": {
                        "contacts": [
                            {
                                "input": "447001001001",
                                "wa_id": "447001001001"
                            }
                        ],
                        "messages": [
                            {
                                "id": "gBEGTHcVF4YFAgkbt37BX1L-tvg"
                            }
                        ],
                        "meta": {
                            "api_status": "stable",
                            "version": "2.55.1"
                        },
                        "conversation": {
                            "expiration_timestamp": 1730282580,
                            "id": "f9265945b17526717f739e445ed056f2",
                            "origin": {
                                "type": "utility"
                            }
                        },
                        "id": "gBEGTHcVF4YFAgkbt37BX1L-tvg",
                        "message": {
                            "recipient_id": "447001001001"
                        },
                        "pricing": {
                            "billable": true,
                            "category": "utility",
                            "pricing_model": "CBP"
                        },
                        "status": "sent",
                        "timestamp": "1730196539",
                        "type": "message"
                    }
                },
                "fbMessenger": {
                    "status": "pending"
                },
                "email": {
                    "status": "pending"
                }
            }
        },
        "channelData": {
            "whatsApp": {
                "virtualDeviceNumber": "447123123123",
                "originatorPhoneNumber": "447123123123",
                "isTemplateMessage": true,
                "isWithinConversationWindow": false,
                "phoneNumberCountryCode": "GB"
            }
        },
        "updatedOn": "2024-10-29T10:08:59.000Z",
        "_apiSpaceId": "61d1780d-8440-480a-b268-20b1eb50a4ff"
    },
    "revision": 3,
    "etag": "\"2e-EgwZ9mai3uos3CKWlv4t8Dim1gw\"",
    "timestamp": "2024-10-29T10:09:00.072Z"
}

{
    "eventId": "769f4305-ea98-45ae-860b-a32e44b9aa47",
    "accountId": 1234,
    "apiSpaceId": "61d1780d-8440-480a-b268-20b1eb50a4ff",
    "name": "message.sent",
    "payload": {
        "id": "8b6076fe-4c85-4f92-a195-3625a7a62c32",
        "details": {
            "channel": "appMessaging",
            "additionalInfo": {
                "conversationId": "Customer_Services_anon_4c191a33-050b-4bab-9147-38300445fdd4",
                "conversationMessageId": "8b6076fe-4c85-4f92-a195-3625a7a62c32"
            },
            "channelStatus": {}
        },
        "conversationId": "Customer_Services_anon_4c191a33-050b-4bab-9147-38300445fdd4",
        "updatedOn": "2019-03-07T10:37:21.529Z"
    },
    "revision": 2,
    "etag": "\"2e-lvaY1DE4bB43iP6/vi6xlcm3rGI\"",
    "timestamp": "2019-03-07T10:37:21.640Z"
}

{
    "eventId": "30d79f1d-7cf1-4445-9a75-93d98b2f3304",
    "accountId": 1234,
    "apiSpaceId": "ae1f5482-2438-41ce-ac1a-9137491f701d",
    "name": "message.sent",
    "payload": {
        "id": "8e5cb2fa-d2a6-41d7-81ab-06296d7ce20b",
        "details": {
            "channel": "nativePush",
            "additionalInfo": [
                {
                    "responseCode": "success",
                    "response": {
                        "multicast_id": 8419673992163110000,
                        "success": 1,
                        "failure": 0,
                        "canonical_ids": 0,
                        "results": [
                            {
                                "message_id": "0:1674653547327900%d06afe6fd06afe6f"
                            }
                        ]
                    },
                    "attempts": 1
                }
            ],
            "channelStatus": {
                "nativePush": {
                    "status": "sent",
                    "updatedOn": "2023-01-25T13:32:27.368Z",
                    "details": [
                        {
                            "responseCode": "success",
                            "response": {
                                "multicast_id": 8419673992163110000,
                                "success": 1,
                                "failure": 0,
                                "canonical_ids": 0,
                                "results": [
                                    {
                                        "message_id": "0:1675653547327900%d06afe6fd06afe6f"
                                    }
                                ]
                            },
                            "attempts": 1
                        }
                    ]
                }
            }
        },
        "metadata": {
            "data": "My correlation data"
        },
        "updatedOn": "2023-01-25T13:32:27.215Z"
    },
    "revision": 2,
    "etag": "\"2e-6MBNH+Xzq1MpggufFV5zpxUf498\"",
    "timestamp": "2023-01-25T13:32:27.440Z"
}

{
  "eventId": "487b9258-aee0-48da-b410-b253823fda10",
  "accountId": 1234,
  "apiSpaceId": "fa42e8af-5fc4-40d4-a38c-034535c0a385",
  "name": "message.sent",
  "payload": {
    "details": {
      "channel": "fbMessenger",
      "additionalInfo": {
        "fbMessengerId": "1924625277845988",
        "messageId": "mid.$cABAnV7v5AVdiiyqOdVcWeVGDyz-6"
      },
      "channelStatus": {
        "fbMessenger": {
          "status": "sent",
          "details": {
            "fbMessengerId": "1924625277645988",
            "messageId": "mid.$cABAnV7v5AVdiiyqOdVcWeVGDyz-6"
          },
          "updatedOn": "2017-05-30T15:06:56.934Z"
        }
      }
    },
    "updatedOn": "2017-05-30T15:06:56.934Z",
    "id": "79b156e6-c314-4114-ac6a-be8eab624951"
  },
  "revision": 2,
  "etag": "\"2e-Zb4yVYmVGmr9WRNuY47SF8Vd21I\"",
  "timestamp": "2017-05-30T15:06:57.592Z"
}

Sent Request

This event indicates a message has been sent on a channel, and also includes the original request details.

Examples

{
    "name": "message.sentRequest",
    "accountId": 1234,
    "apiSpaceId": "c924cf6e-4352-4b26-a71a-c2032bea7a01",
    "eventId": "efbde3e8-dd98-4a3a-8769-7831d492ded1",
    "etag": "\"2e-6cn20vgOOzmja2j6aTgAjKn2epE\"",
    "revision": 2,
    "timestamp": "2026-04-29T16:56:26.786Z",
    "payload": {
        "id": "87acb334-184a-40be-aa82-b272d441d2ce",
        "request": {
            "requestedOn": "2026-04-29T16:56:22.472Z",
            "channel": "sms",
            "to": {
                "phoneNumber": "447123123123",
                "phoneNumberCountryCode": "GB",
                "profileId": "anon_e7717170-d091-4ee2-a34d-1086f3da2717",
                "firstName": "Jim",
                "lastName": "Mysterio",
                "email": "jim.mysterio@emailsim.io",
                "countryCode": "GBR",
                "accountNumber": "YW5vbl9jNzkx",                
                "isAnonymous": false
            },
            "requireOptIn": false,
            "body": "This is a sample message.",
            "messageParts": []
        },
        "sentDetails": {
            "channel": "sms",
            "updatedOn": "2026-04-29T16:56:25.485Z",
            "additionalInfo": {
                "source": "mirroring"
            },
            "channelStatus": {
                "sms": {
                    "status": "sent",
                    "updatedOn": "2026-04-29T16:56:25.485Z",
                    "details": {
                        "statusId": 3,
                        "statusDescription": "Messages queued for delivery at SMSC",
                        "segmentCount": 1
                    }
                }
            },
            "channelData": {
                "sms": {
                    "phoneNumberCountryCode": "GB",
                    "segmentCount": 1
                }
            }
        },
        "_apiSpaceId": "c924cf6e-4352-4b26-a71a-c2032bea7a01"
    }
}

{
    "name": "message.sentRequest",
    "accountId": 1234,
    "apiSpaceId": "c924cf6e-4352-4b26-a71a-c2032bea7a01",
    "eventId": "ab700282-0d37-4236-b6cc-ddc5a9ba9201",
    "etag": "\"2e-dGY1AYDqwHRAeRvHAwCxHTwMTdQ\"",
    "revision": 2,
    "timestamp": "2026-04-29T16:51:15.128Z",
    "payload": {
        "id": "264ad59a-6149-42d5-8585-3f3871a3b921",
        "request": {
            "requestedOn": "2026-04-29T16:51:08.553Z",
            "channel": "whatsApp",
            "to": {
                "phoneNumber": "447123123123",
                "phoneNumberCountryCode": "GB",
                "profileId": "anon_e7717170-d091-4ee2-a34d-1086f3da2717",
                "firstName": "Jim",
                "lastName": "Mysterio",
                "email": "jim.mysterio@emailsim.io",
                "countryCode": "GBR",
                "accountNumber": "YW5vbl9jNzkx",
                "whatsApp": {
                    "whatsAppId": "447123123123",
                    "lastValidatedOn": "2026-03-18T16:46:39.204Z",
                    "name": "Jim Mysterio"
                },
                "isAnonymous": false,
                "campaigns": {
                    "interviewDate": null
                }
            },
            "requireOptIn": false,
            "messageParts": [
                {
                    "type": "whatsapp/template",
                    "data": {
                        "templateName": "dispatch_confirmation",
                        "languageCode": "en",
                        "parameters": [
                            {
                                "type": "text",
                                "text": "Dave"
                            },
                            {
                                "type": "text",
                                "text": "1234"
                            }
                        ]
                    }
                }
            ]
        },
        "sentDetails": {
            "channel": "whatsApp",
            "updatedOn": "2026-04-29T16:51:13.000Z",
            "channelStatus": {
                "whatsApp": {
                    "status": "sent",
                    "updatedOn": "2026-04-29T16:51:13.000Z",
                    "details": {}
                }
            },
            "channelData": {
                "whatsApp": {
                    "originatorPhoneNumber": "447861233123",
                    "isTemplateMessage": true,
                    "templateCategory": "UTILITY",
                    "isWithinConversationWindow": false,
                    "phoneNumberCountryCode": "GB"
                }
            }
        },
        "_apiSpaceId": "c924cf6e-4352-4b26-a71a-c2032bea7a01"
    }
}

{
    "name": "message.sentRequest",
    "accountId": 1234,
    "apiSpaceId": "c224cf6e-4352-4b26-a71a-c9032bea7a01",
    "eventId": "a899d9e6-a678-4d89-8e39-3286222e198d",
    "etag": "\"2e-6iT4FCRj8Ie5AV5mNEruWd4jHmE\"",
    "revision": 1,
    "timestamp": "2026-04-29T17:10:50.804Z",
    "payload": {
        "id": "39559152-5aaa-4dd4-897d-c01b9166de54",
        "request": {
            "requestedOn": "2026-04-29T17:10:50.457Z",
            "channel": "appMessaging",
            "to": {
                "profileId": "anon_b8bed159-7953-401c-8985-e26b4bf44c0c",
                "isAnonymous": true
            },
            "requireOptIn": false,
            "channelOptions": {
                "appMessaging": {
                    "from": {
                        "profileId": "TEAM\\Customer_Services",
                        "name": "Customer Services"
                    }
                }
            },
            "conversationId": "Customer_Services_anon_baaed159-7953-401c-8985-e26b4bf44c0c",
            "body": "Hi thanks for visiting. We have some great offers if you register with us today!",
            "customBody": {},
            "messageParts": []
        },
        "sentDetails": {
            "channel": "appMessaging",
            "updatedOn": "2026-04-29T17:10:50.458Z",
            "additionalInfo": {
                "conversationId": "Customer_Services_anon_baaed159-7953-401c-8985-e26b4bf44c0c",
                "conversationMessageId": "39559152-5aaa-4dd4-897d-c01b9166de54"
            },
            "channelStatus": {
                "appMessaging": {
                    "status": "sent",
                    "updatedOn": "2026-04-29T17:10:50.801Z",
                    "details": {
                        "conversationId": "Customer_Services_anon_baaed159-7953-401c-8985-e26b4bf44c0c",
                        "conversationMessageId": "39559152-5aaa-4dd4-897d-c01b9166de54"
                    }
                }
            }
        },
        "_apiSpaceId": "c224cf6e-4352-4b26-a71a-c9032bea7a01"
    }
}

{
    "name": "message.sentRequest",
    "accountId": 1234,
    "apiSpaceId": "c924cf6e-4352-4b26-a71a-c2032bea7a01",
    "eventId": "12a964d1-c719-4d3b-9918-26cbd7bd0248",
    "etag": "\"2e-VZpMfAxlrzywTQngZe+tXbqJoJc\"",
    "revision": 1,
    "timestamp": "2026-04-30T13:42:18.888Z",
    "payload": {
        "id": "61b30aa3-5e8c-4f0c-820e-a19bf3817cb4",
        "request": {
            "requestedOn": "2026-04-30T13:42:17.883Z",
            "channel": "nativePush",
            "to": {
                "profileId": "anon_16cf0c11-b9ec-4f8a-afe5-ec5ef2dc2b35",
                "firstName": "Jim",
                "lastName": "Mysterio",
                "email": "jim.mysterio@emailsim.io"
            },
            "requireOptIn": false,
            "channelOptions": {
                "nativePush": {
                    "deepLink": {
                        "trackingLink": "https://r1.ddlnk.net/push-notifications/click/57GV-4D8H-0ECD78986141B7936MFC4C574DD336B0E67038-7465F11474B1991DAA78DED795CB59D1E?dateSent=2026-04-30T13:42:13.412Z",
                        "fcm": {
                            "url": "https://dotdigital.com"
                        },
                        "apns": {
                            "url": "https://dotdigital.com"
                        }
                    }
                }
            },
            "body": "Test push message with URL",
            "messageParts": [],
            "title": "Test push",
            "metadata": {
                "requestid": "35633067",
                "contactid": "99999",
                "useraccountid": "1234",
                "channeltype": 15,
                "programid": 123321,
                "ddgmessageid": 10
            }
        },
        "sentDetails": {
            "channel": "nativePush",
            "updatedOn": "2026-04-30T13:42:18.298Z",
            "additionalInfo": {
                "device": "e895aef41d7ddc63b8ccaedc56744209bfa6540a5733914873b7c9d40f39ae0c"
            },
            "channelStatus": {
                "nativePush": {
                    "status": "sent",
                    "updatedOn": "2026-04-30T13:42:18.864Z",
                    "details": {
                        "device": "e895aef41d7ddc63b8ccaedc56744209bfa6540a5733914873b7c9d40f39ae0c"
                    }
                }
            }
        },
        "_apiSpaceId": "c924cf6e-4352-4b26-a71a-c2032bea7a01"
    }
}

Delivered

This event indicates that a message has been delivered on a channel, if delivery receipts are supported on the channel.

Examples

{
  "eventId": "2b612e8c-b88d-485c-8e98-81939f879500",
  "accountId": 1234,
  "apiSpaceId": "c224cf6e-4352-4b26-a71a-c9032bea7a01",
  "name": "message.delivered",
  "payload": {
    "details": {
      "channel": "sms",
      "channelStatus": {
        "tranid": "946245251",
        "messageguid": "9fd260a5-52a7-4d84-bc08-10e04d07d7b7",
        "statusid": "1",
        "recipient": "447123123123",
        "statusdescription": "Messages delivered to handset",
        "datetime": "2017-08-31T10:28:00.143",
        "clientref": "e9f154c8-4011-493f-bb73-09cfcf8a1411",
        "submissiontime": "2017-08-31T10:26:14.317",
        "apispaceid": "c224cf6e-4352-4b26-a71a-c9032bea7a01",
        "statustimeutc": "2017-08-31T09:27:21.000Z"
      }
    },
    "metadata": {
      "data": "My correlation data"
    },
    "id": "e9f154c8-4011-493f-bb73-09cfcf8a1411"
  },
  "revision": 3,
  "etag": "\"2e-oazq69nFeiKkl5WM78YH7xo/8xU\"",
  "timestamp": "2017-08-31T09:28:03.074Z"
}

{
    "eventId": "52987c07-7ec8-41c2-bc47-9bad3a9419a6",
    "accountId": 1234,
    "apiSpaceId": "1154802b-a288-48f9-839c-b56181b9f3cf",
    "name": "message.delivered",
    "payload": {
        "id": "b960fa14-9f39-412a-b46f-e073f18e7199",
        "details": {
            "channel": "mms"
        },
        "metadata": {
            "useraccountid": 1234,
            "campaignid": 1518,
            "campaignname": "Test",
            "contactid": 38334181,
            "requestid": 0,
            "sendid": 0,
            "programid": 0
        },
        "updatedOn": "2024-01-12T13:49:38.010Z"
    },
    "revision": 3,
    "etag": "\"2e-nExyCNBg7TA5kGFlJ6i9Qnnvfok\"",
    "timestamp": "2024-01-12T13:49:41.967Z"
}

{
  "eventId": "5e8cc443-1bc9-442c-8a58-f2fd64e3c917",
  "name": "message.delivered",
  "revision": 1,
  "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
  "accountId": 1234,
  "etag": "\"3e-c2By+uFeMnHr6G6vWZII3e360ZM\"",
  "payload": {
    "details": {
      "channel": "transactionalEmail",
      "channelStatus": {
        "toAddresses": "joe.bloggs@emailsim.io,jo.bloggs@acme.com",
        "campaignId": 321,
        "campaignTags": [
          "registration",
          "transactional"
        ],
        "status": "delivered",
        "updatedOn": "2021-10-13T13:09:16.637Z"
      }
    },
    "metadata": {
      "myIdentifier": "abc5",
      "customField": "A value"
    },
    "id": "3bc96422-1cba-4958-b667-b016ac3355b1"
  },
  "timestamp": "2021-10-13T13:09:16.637Z"
}

{
  "eventId": "07006cd8-b9b0-4554-ae49-f6bc7b7a22b9",
  "accountId": 1234,
  "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.delivered",
  "payload": {
    "id": "df80de47-d2d7-436f-afe0-7559f64b0583",
    "details": {
      "channel": "rcs",
      "channelStatus": {
        "data": {
          "senderPhoneNumber": "+447123123123",
          "eventType": "DELIVERED",
          "eventId": "MsuYXA9p9FTcKajFDiwiELqA",
          "messageId": "df80de47-d2d7-436f-afe0-7559f64b0583",
          "sendTime": "2019-10-23T16:17:09.331989Z"
        },
        "attributes": {
          "type": "event",
          "project_number": "770950354877",
          "event_type": "DELIVERED",
          "product": "RBM"
        },
        "messageId": "653513593921442",
        "publishTime": "2019-10-23T16:17:10.329Z"
      }
    },
    "metadata": {
      "data": "My important data"
    },
    "updatedOn": "2019-10-23T16:17:11.325Z"
  },
  "revision": 3,
  "etag": "\"2e-Gcg41t6jFwT2CVW8wouZDroNu9Y\"",
  "timestamp": "2019-10-23T16:17:11.328Z"
}

{
  "eventId": "594c9ae4-114b-4d22-a43a-3fd6e0ad35ca",
  "accountId": 12345,
  "apiSpaceId": "a1d1780d-8340-480a-b268-aab1eb50a4ff",
  "name": "message.delivered",
  "payload": {
    "id": "1502ecc3-0fec-482f-a3d7-3900df233927",
    "details": {
      "channel": "whatsApp",
      "channelStatus": {
        "id": "wamid.HBgMNDQ3NzE1MTc9NjA1FQIAERgSMDdENjYxRERBNTk8RERDMTlGAA==",
        "status": "delivered",
        "timestamp": "1773852405",
        "recipient_id": "447123123123",
        "conversation": {
          "id": "fb1a4b2b79847ae5f2770ebf514860cb",
          "origin": {
            "type": "utility"
          }
        },
        "pricing": {
          "billable": true,
          "pricing_model": "PMP",
          "category": "utility",
          "type": "regular"
        },
        "errors": []
      }
    },
    "updatedOn": "2026-03-18T16:46:45.000Z",
    "_apiSpaceId": "a1d1780d-8340-480a-b268-aab1eb50a4ff"
  },
  "revision": 4,
  "etag": "\"2e-14hnmx3QaafXBvJNW240q3fQhXw\"",
  "timestamp": "2026-03-18T16:46:45.894Z"
}

{
  "eventId": "77775ef0-60f9-4ec1-8fa5-cfc3990e1f94",
  "accountId": 1234,
  "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.delivered",
  "payload": {
    "details": {
      "channel": "fbMessenger",
      "channelStatus": {
        "sender": {
          "id": "1124625277645988"
        },
        "recipient": {
          "id": "138143536705220"
        },
        "timestamp": 1496248541996,
        "delivery": {
          "watermark": 1496248541613,
          "seq": 0
        }
      }
    },
    "updatedOn": "2017-05-31T16:35:41.613Z",
    "id": "0bc1e71e-28f4-40f4-853a-7112fd28f627"
  },
  "revision": 3,
  "etag": "\"2e-5L1Qw6Yi1fL1KMW7AH2amYIvNSI\"",
  "timestamp": "2017-05-31T16:35:43.078Z"
}

{
    "eventId": "ae467606-6dd3-4eb5-aa9a-1901e1e8cecd",
    "accountId": 1234,
    "apiSpaceId": "61d1780d-8440-480a-b268-20b1eb50a4ff",
    "name": "message.delivered",
    "payload": {
        "id": "8b6076fe-4c85-4f92-a195-3625a7a62c32",
        "details": {
            "channel": "appMessaging",
            "channelStatus": {
                "messageId": "8b6076fe-4c85-4f92-a195-3625a7a62c32",
                "conversationId": "Customer_Services_anon_4c191a33-050b-4bab-9147-38300445fdd4",
                "scope": "a2p",
                "direction": "outbound",
                "sentOn": "2019-03-07T10:37:21.624Z",
                "isPublicConversation": false,
                "profileId": "anon_4c191a33-050b-4bab-9147-38300445fdd4",
                "timestamp": "2019-03-07T10:37:21.737Z"
            }
        },
        "conversationId": "Customer_Services_anon_4c191a33-050b-4bab-9147-38300445fdd4",
        "updatedOn": "2019-03-07T10:37:21.737Z"
    },
    "revision": 3,
    "etag": "\"2e-E+VfGOH5aZPuHpiCVUOfy63gnNY\"",
    "timestamp": "2019-03-07T10:37:21.847Z"
}

Read

This event indicates a message has been read on a channel, note this only applies to channels that support read receipts.

Examples

{
  "eventId": "5e8cc443-1bc9-442c-8a58-f2fd64e3c917",
  "name": "message.read",
  "revision": 1,
  "apiSpaceId": "61d1780d-8440-480a-b268-20b1eb50a4ff",
  "accountId": 1234,
  "etag": "\"3e-c2By+uFeMnHr6G6vWZII3e360ZM\"",
  "payload": {
    "details": {
      "channel": "transactionalEmail",
      "channelStatus": {
        "toAddresses": "joe.bloggs@emailsim.io,jo.bloggs@acme.com",
        "campaignId": 321,
        "campaignTags": [
          "registration",
          "transactional"
        ],
        "ip": "216.213.174.157",
        "updatedOn": "2021-10-13T13:09:16.637Z",
        "userAgent": "Mozilla/4.0 (compatible; ms-office; MSOffice 16)"
      }
    },
    "metadata": {
      "myIdentifier": "abc5",
      "customField": "A value"
    },
    "id": "3bc96422-1cba-4958-b667-b016ac3355b1"
  },
  "timestamp": "2021-10-13T13:09:16.637Z"
}

{
  "eventId": "8a418712-a341-480a-9e61-e750ee27cde2",
  "accountId": 1234,
  "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.read",
  "payload": {
    "id": "208bd9df-efd0-42d2-9f4a-56f97258c3a1",
    "details": {
      "channel": "rcs",
      "channelStatus": {
        "data": {
          "senderPhoneNumber": "+447123123123",
          "eventType": "READ",
          "eventId": "MsFHSpJVEUSRKSZQkEX4NNmg",
          "messageId": "208bd9df-efd0-42d2-9f4a-56f97258c3a1",
          "sendTime": "2019-10-24T08:36:49.527958Z"
        },
        "attributes": {
          "type": "event",
          "project_number": "770950354877",
          "event_type": "READ",
          "product": "RBM"
        },
        "messageId": "653537493453991",
        "publishTime": "2019-10-24T08:36:50.349Z"
      }
    },
    "metadata": {
      "data": "My important data"
    },
    "updatedOn": "2019-10-24T08:36:51.027Z"
  },
  "revision": 4,
  "etag": "\"2e-TxeQvmtFPwKmf7wpfCirDLiBf1o\"",
  "timestamp": "2019-10-24T08:36:51.032Z"
}

{
    "eventId": "56bc24dd-4294-426d-8404-568d60537e6d",
    "accountId": 12345,
    "apiSpaceId": "62d1780d-8440-480a-b268-20b1eb50a4ff",
    "name": "message.read",
    "payload": {
        "id": "c94a82da-55e8-4a29-922c-ba4aed3e5990",
        "details": {
            "channel": "whatsApp",
            "channelStatus": {
                "id": "gBEGTHcVF4YFAgkbt37BX1L-tvg",
                "message": {
                    "recipient_id": "447001001001"
                },
                "status": "read",
                "timestamp": "1730196546",
                "type": "message"
            }
        },
        "updatedOn": "2024-10-29T10:09:06.000Z",
        "_apiSpaceId": "62d1780d-8440-480a-b268-20b1eb50a4ff"
    },
    "revision": 5,
    "etag": "\"2e-dHtoU1YE6mj66EFkDspdUDzgW4k\"",
    "timestamp": "2024-10-29T10:09:06.358Z"
}

{
  "eventId": "4fb53a11-48a0-46e6-af4c-946556f03445",
  "accountId": 1234,
  "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.read",
  "payload": {
    "details": {
      "channel": "fbMessenger",
      "channelStatus": {
        "sender": {
          "id": "1124625277645988"
        },
        "recipient": {
          "id": "138143536705220"
        },
        "timestamp": 1496248566710,
        "read": {
          "watermark": 1496248541613,
          "seq": 0
        }
      }
    },
    "updatedOn": "2017-05-31T16:35:41.613Z",
    "id": "0bc1e71e-28f4-40f4-853a-7112fd28f627"
  },
  "revision": 4,
  "etag": "\"2e-konny6DS4WEpVq5z2UDXb98kYQw\"",
  "timestamp": "2017-05-31T16:36:07.407Z"
}

{
    "eventId": "43a708b8-e884-49d6-92eb-cd75b7707f52",
    "accountId": 1234,
    "apiSpaceId": "61d1780d-8440-480a-b268-20b1eb50a4ff",
    "name": "message.read",
    "payload": {
        "id": "8b6076fe-4c85-4f92-a195-3625a7a62c32",
        "details": {
            "channel": "appMessaging",
            "channelStatus": {
                "messageId": "8b6076fe-4c85-4f92-a195-3625a7a62c32",
                "conversationId": "Customer_Services_anon_4c191a33-050b-4bab-9147-38300445fdd4",
                "scope": "a2p",
                "direction": "outbound",
                "sentOn": "2019-03-07T10:37:21.624Z",
                "isPublicConversation": false,
                "profileId": "anon_4c191a33-050b-4bab-9147-38300445fdd4",
                "timestamp": "2019-03-07T10:37:21.750Z"
            }
        },
        "conversationId": "Customer_Services_anon_4c191a33-050b-4bab-9147-38300445fdd4",
        "updatedOn": "2019-03-07T10:37:21.750Z"
    },
    "revision": 4,
    "etag": "\"2e-kvIDONdrGVEMD3E2ElniLL62jcA\"",
    "timestamp": "2019-03-07T10:37:21.864Z"
}

Expired

This event indicates a message has not been delivered within the specified expiry period.

Examples

{
  "eventId": "c88f35a8-5fe7-4069-9151-f4dcf8ee89b3",
  "accountId": 1234,
  "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.expired",
  "payload": {
    "details": {
      "channel": "sms",
      "channelStatus": {}
    },
    "updatedOn": "2017-06-01T10:45:05.685Z",
    "id": "a3c0c65c-6199-43e1-ba43-e7184a583e86"
  },
  "revision": 3,
  "etag": "\"2e-gTE0IKqsj+rNG0tojkpW/WZezTc\"",
  "timestamp": "2017-06-01T16:07:19.777Z"
}

{
  "eventId": "54c73a43-813a-4be1-8542-2ea3b1927ac5",
  "accountId": 12345,
  "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.expired",
  "payload": {
    "id": "874382e6-3f41-488a-ad89-08050671bc93",
    "details": {
      "channel": "mms"
    },
    "updatedOn": "2025-02-05T15:10:06.220Z",
    "_apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385"
  },
  "revision": 3,
  "etag": "\"2e-MSnqUVFB0TJ43nb0HrtD1IAwYag\"",
  "timestamp": "2025-02-05T15:10:06.361Z"
}

Failed

This event indicates that the message has failed to be sent or delivered.

🚧
You only receive channel statuses for non general failures
If your message is accepted but when we try to send we have an issue and cannot send it on any of the channels requested, then you will receive a message.failed event but with no details in the channelStatus object. If we are able to submit to a channel but an issue occurs, then the channelStatus object will contain an object describing the channel issue. See the examples above.

Examples

{
    "eventId": "8270b263-4b21-4396-be5a-deb7803bbe3a",
    "accountId": 1234,
    "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
    "name": "message.failed",
    "payload": {
        "details": {
            "reason": "The message failed because it could not be sent to any of the configured channels.",
            "channelStatus": {}
        },
        "updatedOn": "2018-06-28T09:56:17.296Z",
        "metadata": {
            "myMessageId": 45210
        },
        "id": "0c7d3c2c-c90b-4d12-8416-683420186d08"
    },
    "revision": 2,
    "etag": "\"2e-xiPUac66W8M5clJfkYKXKQ/nBR8\"",
    "timestamp": "2018-06-28T09:56:17.305Z"
}

{
    "eventId": "c14320d9-6f24-48c6-a981-15879b756203",
    "accountId": 1234,
    "apiSpaceId": "ae1f5482-2438-41ce-ac1a-9137491f701d",
    "name": "message.failed",
    "payload": {
        "id": "37fe6fcc-8149-48d0-baf9-1c72850d532b",
        "details": {
            "channelStatus": {
                "sms": {
                    "status": "failed",
                    "details": {
                        "reason": "Rejected by operator",
                        "data": {
                            "tranid": "78303243",
                            "messageguid": "a88cf899-07dc-47c0-873f-f2dba2dc35f1",
                            "statusid": "4",
                            "recipient": "447123123123",
                            "statusdescription": "Messages rejected by operator",
                            "datetime": "2019-04-12T10:47:00.237",
                            "clientref": "37fe6fcc-8149-48d0-baf9-1c72850d532b",
                            "submissiontime": "2019-04-12T10:41:13.073",
                            "apispaceid": "AE1F5482-2438-41CE-AC1A-9137491F701D",
                            "statustimeutc": "2019-04-12T09:46:00.000Z"
                        }
                    },
                    "updatedOn": "2019-04-12T09:46:00.000Z"
                }
            },
            "reason": "Channel reported the message was undeliverable"
        },
        "metadata": {
            "data": "My correlation data"
        },
        "updatedOn": "2019-04-12T09:46:00.000Z"
    },
    "revision": 4,
    "etag": "\"2e-9e8qfTZb9PDAQGEExbOz24FWjPk\"",
    "timestamp": "2019-04-12T09:47:00.657Z"
}

{
  "eventId": "05618bd9-dba3-4105-9f71-492df2b031c2",
  "accountId": 1234,
  "apiSpaceId": "1154802b-a288-48f9-839c-b56181b9f3cf",
  "name": "message.failed",
  "payload": {
    "id": "32de4778-9b9d-4c33-8486-203b2b70db02",
    "details": {
      "channelStatus": {},
      "reason": "Invalid request:\r\n1) Not allowed to send message to 48500000000 (PL) for mms channel. Allowed country codes are: US,CA (paramName: phoneNumberCountryCode)"
    },
    "updatedOn": "2023-11-13T08:23:00.992Z",
		"metadata": {
      "useraccountid": 1234,
      "campaignid": 1518,
      "campaignname": "Test",
      "contactid": 111111,
      "requestid": 0,
      "sendid": 0,
      "programid": 0
    }
  },
  "revision": 1,
  "etag": "\"2e-2xMXoYeZe7V7GPlmMik+VpstP9g\"",
  "timestamp": "2023-11-13T08:23:01.057Z"
}

{
  "eventId": "9e33d815-3700-46fd-a9f7-97004298747d",
  "accountId": 1234,
  "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.failed",
  "payload": {
    "id": "8d7e7543-92e3-4acd-abfe-d527a7ea580b",
    "details": {
      "reason": "The message failed because it could not be sent to any of the configured channels.",
      "channelStatus": {
        "rcs": {
          "status": "failed",
          "updatedOn": "2019-10-24T13:31:11.619Z",
          "details": {
            "reason": "The profile is not tester",
            "data": {
              "phoneNumber": "447123123123",
              "phoneNumberCountryCode": "GB",
              "profileId": "e9395e29-a4b8-4d4c-9ea1-f6e1a676ac62"
            }
          }
        }
      }
    },
    "metadata": {
      "data": "My important data"
    },
    "updatedOn": "2019-10-24T13:31:11.619Z"
  },
  "revision": 2,
  "etag": "\"2e-7KQ6HOIk/Wlv5NWBmcEYBa9ZL+s\"",
  "timestamp": "2019-10-24T13:31:11.633Z"
}

{
  "eventId": "469330e1-2513-49f2-ae8f-bde4c9b4a908",
  "name": "message.failed",
  "revision": 1,
  "apiSpaceId": "61d1780d-8440-480a-b268-20b1eb50a4ff",
  "accountId": 1234,
  "etag": "\"40-Osoan6PAFwhkBxLc4A65VbhYYhk\"",
  "payload": {
    "details": {
      "reason": "The message failed because it could not be sent to any of the configured channels.",
      "channelStatus": {
        "transactionalEmail": {
          "campaignTags": null,
          "status": "Hard Bounce",
          "updatedOn": "2021-10-13T13:29:20.933Z",
          "details": {
            "reason": "Hard Bounce",
            "data": {
              "toAddresses": "joe.bloggs@emailsim.io,jo.bloggs@acme.com",
              "ccAddresses": null,
              "bccAddresses": null,
              "campaignId": 321,
              "campaignTags": [
                "registration",
                "transactional"
              ]
            }
          }
        }
      },
      "updatedOn": "2021-10-13T13:29:20.933Z",
      "metadata": {
        "myIdentifier": "abc5",
        "customField": "A value"
      },
      "id": "aeb03117-1c73-449f-b344-6aa66dca0b7d"
    },
    "timestamp": "2021-10-13T13:29:20.933Z"
  }
}

{
  "eventId": "319472e0-1552-4878-bb60-5b4dd89402ba",
  "name": "message.failed",
  "revision": 1,
  "apiSpaceId": "61d1780d-8440-480a-b268-20b1eb50a4ff",
  "accountId": 1234,
  "etag": "\"41-jRVwGjfNEWqKiFpnFiaMawh9fD0\"",
  "payload": {
    "details": {
      "reason": "Personalization failed",
      "channelStatus": {
        "transactionalEmail": {
          "status": "Failed",
          "updatedOn": "2026-01-26T09:55:19.610Z",
          "details": {
            "reason": "Personalization failed",
            "data": {
              "toAddresses": "bob@emailsium.io",
              "ccAddresses": "bobby@emailsium.io",
              "bccAddresses": "bob_jnr@emailsium.io",
              "campaignId": 58228,
              "campaignTags": [
                "Transactional emails"
              ]
            }
          }
        }
      }
    },
    "updatedOn": "2026-01-26T09:55:19.610Z",
    "metadata": null,
    "id": "8d09ac9d-9b62-4021-92d9-b33418675172"
  },
  "timestamp": "2026-01-26T09:55:19.610Z"
}

{
  "eventId": "d8536261-ee1d-4b88-8f2e-89d9ea35dd1b",
  "accountId": 1234,
  "apiSpaceId": "c224cf6e-4352-4b26-a71a-c9032bea7a01",
  "name": "message.failed",
  "payload": {
    "details": {
      "reason": "The message failed because it could not be sent to any of the configured channels.",
      "channelStatus": {
        "fbMessenger": {
          "status": "failed",
          "details": {
            "reason": "connect ETIMEDOUT 31.13.71.1:443"
          },
          "updatedOn": "2017-08-31T11:13:38.238Z"
        }
      }
    },
    "updatedOn": "2017-08-31T11:13:38.239Z",
    "id": "2a680295-581f-41a7-8825-c6d488e87d07"
  },
  "revision": 2,
  "etag": "\"2e-X5EBTbPlzb3vKVB3mCNjthHMD2E\"",
  "timestamp": "2017-08-31T11:13:37.895Z"
}

{
  "eventId": "0ee4c8b6-0cc5-4e51-828d-58ce51bcb476",
  "accountId": 1234,
  "apiSpaceId": "1944aba6-a66d-4ebe-9010-5567e7ba3b25",
  "name": "message.failed",
  "payload": {
    "id": "17377be2-4e2e-4d4d-81c4-760f8bd81c05",
    "details": {
      "reason": "The message failed because it could not be sent to any of the configured channels.",
      "channelStatus": {
        "sms": {
          "status": "failed",
          "updatedOn": "2022-11-30T16:01:10.382Z",
          "details": {
            "reason": "SMS channel returned a status of unsuccessful",
            "data": {
              "to": "44123123123",
              "successful": false,
              "clientRef": "17377be2-4e2e-4d4d-81c4-760f8bd81c05",
              "segmentCount": 0,
              "validationFailures": [
                {
                  "property": "body",
                  "failureCode": "UnicodeBodyRejected",
                  "details": "body field is not valid. Unicode content is not allowed when PreventUnicode is true."
                }
              ]
            }
          }
        }
      }
    },
    "updatedOn": "2022-11-30T16:01:10.388Z"
  },
  "revision": 2,
  "etag": "\"2e-2K2j7Y290E9imvp2K8wIfr8hbOI\"",
  "timestamp": "2022-11-30T16:01:10.474Z"
}

{
    "eventId": "c89b2176-3d33-4bb8-a016-2557e5aa1bf5",
    "accountId": 1234,
    "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
    "name": "message.failed",
    "payload": {
        "id": "6617603e-a56b-45f7-8784-d07e59b38f17",
        "details": {
            "reason": "The message failed because it could not be sent to any of the configured channels.",
            "channelStatus": {
                "nativePush": {
                    "status": "failed",
                    "updatedOn": "2023-01-25T13:11:24.903Z",
                    "details": {
                        "reason": "The recipient did not have any push details registered"
                    }
                }
            }
        },
        "updatedOn": "2023-01-25T13:11:24.903Z"
    },
    "revision": 2,
    "etag": "\"2e-f0dYS7W3teSoTwUFnpLuNTlOUpc\"",
    "timestamp": "2023-01-25T13:11:25.016Z"
}

{
  "messageId": "13a4090d-59f5-4f5f-8b5c-44904e4f33cd",
  "channel": "whatsApp",
  "status": "failed",
  "subStatus": "Channel reported the message was undeliverable",
  "to": {
    "recipient": "447123123123",
    "contactId": 12345,
    "identifiers": {
      "crm_id": "crm1234",
      "custom_id": "9876xy"
    }
  },
  "campaignDetails": {
    "id": 553355,
    "name": "Deal of the day",
    "type": "standard"
  },
  "program": {
    "id": 35464,
    "name": "Intro journey"
  },
  "channelData": {
    "whatsApp": {
      "status": "failed",
      "details": {
        "reason": "See data property for details",
        "data": {
          "id": "wamid.HBgMNDQ3MTIzMTIzMTIzFQIAERgSQjlBMjZFMDlFRUU4RkNBMDM0AA==",
          "status": "failed",
          "timestamp": "1773852507",
          "recipient_id": "447123123123",
          "errors": [
            {
              "code": 131026,
              "title": "Message undeliverable",
              "message": "Message undeliverable",
              "error_data": {
                "details": "Message Undeliverable."
              }
            }
          ]
        }
      },
      "updatedOn": "2026-03-18T16:48:27.000Z"
    }
  },
  "metaData": {
    "useraccountid": 264621002,
    "campaignid": 6,
    "campaignname": "test",
    "campaignType": "standard",
    "splittestVariant": "A",
    "contactid": 5008,
    "identifiers": {
      "crm_id": "crm1234",
      "custom_id": "9876xy"
    },
    "requestid": 0,
    "sendid": 0,
    "toPhoneNumber": "447123123123",
    "programid": 0,
    "programName": "Test program 1",
    "contactphonenumberid": 5008
  }
}

Inbound

This event is an inbound message from a channel.

Examples

{
    "eventId": "cb49c4de-ebe4-4958-b4c8-11bceb8b6a85",
    "accountId": 1234,
    "apiSpaceId": "c224cf6e-4352-4b26-a71a-c9032bea7a01",
    "name": "message.inbound",
    "payload": {
        "from": {
            "phoneNumber": "447234234234",
            "phoneNumberCountryCode": "GB",
            "profileId": "anon_53bcf4cc-16e7-48c6-a49c-679a30ffcefe"
        },
        "channel": "sms",
        "to": {
            "phoneNumber": "447123123123"
        },
        "body": "Thank you",
        "channelData": {
            "messageId": "1816987461",
            "keyword": "",
            "clientRef": "96ddb2a2-3a7c-4ab2-a6fb-4b7e8705ceae",
            "receivedOn": "2022-06-06T13:36:07.000Z"
        },
        "correlation": {
            "messageId": "96ddbba2-3a7c-4ab2-a6fb-4b7e8705ceae",
            "metadata": {
                "data": "My correlation data",
                "moreData": "You can hold any structured JSON data!"
            }
        },
        "id": "dc1b9f1f-68f5-489f-95d0-057a0e38f647",
        "receivedOn": "2022-06-06T13:36:08.125Z"
    },
    "revision": 0,
    "etag": "\"2e-AqpTftcX/C1F6+XVnon18EHtZE8\"",
    "timestamp": "2022-06-06T13:36:08.149Z"
}

{
  "eventId": "020b8e91-a116-47c6-b7e9-dab878e5761a",
  "accountId": 1234,
  "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.inbound",
  "payload": {
    "from": {
      "fbMessengerId": "1924625277645988",
      "profileId": "joe.blogs@acme.com"
    },
    "channel": "fbMessenger",
    "body": "Hi there",
    "channelData": {
      "pageId": "118143536805220",
      "body": {
        "sender": {
          "id": "1924625277645988"
        },
        "recipient": {
          "id": "118143536805220"
        },
        "timestamp": 1496157103192,
        "message": {
          "mid": "mid.$cAAAnV7v5AVdiiy7sWFcWemjwmFUt",
          "seq": 611,
          "text": "Hi there"
        }
      }
    },
    "id": "8e14bc40-cf93-44bf-be7b-d5dfa77cb53e",
    "receivedOn": "2017-05-30T15:11:44.451Z"
  },
  "revision": 0,
  "etag": "\"2e-gLoREj4XI35uB44EZ2pYIeiIhls\"",
  "timestamp": "2017-05-30T15:11:45.169Z"
}

{
  "eventId": "bb7529b7-6f42-48ae-9c7c-f4787f0309c1",
  "accountId": 1234,
  "apiSpaceId": "fb42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.inbound",
  "payload": {
    "from": {
      "fbMessengerId": "1924625277645988",
      "profileId": "joe.blogs@acme.com"
    },
    "channel": "fbMessenger",
    "channelData": {
      "pageId": "118143536805220",
      "body": {
        "sender": {
          "id": "1924625277645988"
        },
        "recipient": {
          "id": "118143536805220"
        },
        "timestamp": 1496157323290,
        "message": {
          "mid": "mid.$cAAAnV7v5AVdiizJIGlcWez6SN4a6",
          "seq": 613,
          "attachments": [
            {
              "type": "image",
              "payload": {
                "url": "https://scontent.xx.fbcdn.net/v/t35.0-12/18836412_972877662815683_1343824608_o.png?_nc_ad=z-m&oh=bb64923a45848c937f15cbb415bf7942&oe=592F8F05"
              }
            }
          ]
        }
      }
    },
    "id": "2e779cb8-681d-440f-b48a-c0e6061cecc0",
    "receivedOn": "2017-05-30T15:15:32.120Z"
  },
  "revision": 0,
  "etag": "\"2e-JpSAWx+NJaPfrFzaDVTp863rgZ4\"",
  "timestamp": "2017-05-30T15:15:32.873Z"
}

{
    "eventId": "024c3f39-86a9-47a8-b3b9-7a1fc3e273e3",
    "accountId": 1234,
    "apiSpaceId": "61d1780d-8440-480a-b268-20b1eb50a4ff",
    "name": "message.inbound",
    "payload": {
        "from": {
            "profileId": "anon_4c191a33-050b-4bab-9147-38300445fdd4"
        },
        "to": {
            "conversationId": "Customer_Services_anon_4c191a33-050b-4bab-9147-38300445fdd4",
            "profileId": "TEAM\\Customer_Services"
        },
        "channel": "appMessaging",
        "channelData": {
            "messageId": "36136f57-7c13-4a6b-bc17-67f5c4dfd201",
            "metadata": {},
            "context": {
                "from": {
                    "id": "anon_4c191a33-050b-4bab-9147-38300445fdd4"
                },
                "conversationId": "Customer_Services_anon_4c191a33-050b-4bab-9147-38300445fdd4",
                "sentBy": "session:anon_4c191a33-050b-4bab-9147-38300445fdd4",
                "sentOn": "2019-03-07T10:40:49.118Z",
                "scope": "a2p",
                "direction": "inbound"
            },
            "parts": [
                {
                    "data": "Hi there",
                    "size": 8,
                    "type": "text/plain"
                }
            ]
        },
        "body": "Hi there",
        "correlation": {
            "messageId": "8b6076fe-4c85-4f92-a195-3625a7a62c32"
        },
        "id": "13a4090d-59f5-4f5f-8b5c-44904e4f33cd",
        "receivedOn": "2019-03-07T10:41:16.184Z"
    },
    "revision": 0,
    "etag": "\"2e-XQsB+++7ler4ZxAAPBVKJ1apYKs\"",
    "timestamp": "2019-03-07T10:41:16.193Z"
}

{
  "eventId": "833b5df1-7238-4916-bd2d-5ef0ebf24d61",
  "accountId": 1234,
  "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.inbound",
  "payload": {
    "from": {
      "phoneNumber": "447123123123",
      "phoneNumberCountryCode": "GB",
      "profileId": "98f16701-7041-4511-b0ab-34a4554599de"
    },
    "channel": "rcs",
    "to": {
      "agentId": "770950354877"
    },
    "messageParts": [
      {
        "type": "text/plain",
        "data": "Hi"
      }
    ],
    "receivedOn": "2019-10-24T13:46:55.502Z",
    "body": "Hi",
    "correlation": {
      "messageId": "eeabef3f-848d-4a00-8aaa-c7779648d7e5",
      "metadata": {
        "data": "My important data"
      }
    },
    "id": "5f111b34-b9c8-483f-afa2-eeeed6346366"
  },
  "revision": 0,
  "etag": "\"2e-82hH53sJtouGf0qQqqxl6xNQwS0\"",
  "timestamp": "2019-10-24T13:46:55.531Z"
}

{
  "eventId": "1c26007e-7e3a-4c2e-a6ef-5c8a8d7b4d94",
  "accountId": 1234,
  "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.inbound",
  "payload": {
    "from": {
      "phoneNumber": "447123123123",
      "phoneNumberCountryCode": "GB",
      "profileId": "98f16701-7041-4511-b0ab-34a4554599de"
    },
    "channel": "rcs",
    "to": {
      "agentId": "770950354877"
    },
    "messageParts": [
      {
        "type": "application/pdf",
        "url": "https://rcs-user-content-eu.storage.googleapis.com/802acc59-605f-417c-c2fb-877222c2d1e7/5f5cd9e112c64f47aa79368b945643b3e4ef51021d739db15d07cbcfacc5",
        "name": "ClaimsForm.pdf"
      }
    ],
    "receivedOn": "2019-10-29T16:38:46.405Z",
    "correlation": {
      "messageId": "419b23d5-8e82-4b05-9a30-b2d91400033d",
      "metadata": {
        "data": "My important data"
      }
    },
    "id": "1be3b3cf-e93e-4b81-97ca-2b747ec2a8ff"
  },
  "revision": 0,
  "etag": "\"2e-Kf5vZlGmG20yIO7oPsDxEPZUiW8\"",
  "timestamp": "2019-10-29T16:38:46.428Z"
}

{
  "eventId": "d40f6c64-2687-40db-8315-b2a7c486cb6b",
  "accountId": 1234,
  "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.inbound",
  "payload": {
    "from": {
      "phoneNumber": "447123123123",
      "phoneNumberCountryCode": "GB",
      "profileId": "98f16701-7041-4511-b0ab-34a4554599de"
    },
    "channel": "rcs",
    "to": {
      "agentId": "770950354877"
    },
    "messageParts": [
      {
        "type": "image/gif",
        "url": "https://rcs-user-content-eu.storage.googleapis.com/403705b0-5638-45d3-91a7-cd2d3cbadfe7/8b4c1b0f711bbbc4fe07b751edb494ef09c00f7b21f5ba83015d25e6ca23",
        "name": "3"
      }
    ],
    "receivedOn": "2019-10-29T16:21:06.195Z",
    "correlation": {
      "messageId": "419b23d5-8e82-4b05-9a30-b2d91400033d",
      "metadata": {
        "data": "My important data"
      }
    },
    "id": "7ba338db-fb7c-46ed-8d45-ffab38a5c5c6"
  },
  "revision": 0,
  "etag": "\"2e-eiv0ZMO6mzU2sO0z3TL69n1ux2E\"",
  "timestamp": "2019-10-29T16:21:06.197Z"
}

{
  "eventId": "69402c9c-672d-41fb-9e9d-7512f0b83a71",
  "accountId": 1234,
  "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
  "name": "message.inbound",
  "payload": {
    "from": {
      "phoneNumber": "447123123123",
      "whatsApp": {
        "whatsAppId": "447123123123",
        "name": "Tom Smith"
      },
      "phoneNumberCountryCode": "GB",
      "profileId": "anon_7b1302b0-4433-439e-bfb2-94e5daf21f9c"
    },
    "channel": "whatsApp",
    "channelData": {
      "whatsApp": {
        "isCloudOriginator": true
      }
    },
    "to": {
      "phoneNumber": "447700600000"
    },
    "messageParts": [
      {
        "type": "text/plain",
        "data": "Hello from WhatsApp"
      }
    ],
    "receivedOn": "2020-11-26T14:07:41.207Z",
    "body": "Hello from WhatsApp",
    "correlation": {
      "messageId": "85bf4ea4-8791-4c97-b9c5-4922f66c4b6f"
    },
    "id": "ef2a5dfa-c2be-4d15-8b8f-d0300c2963eb"
  },
  "revision": 0,
  "etag": "\"2e-O2FOl5l5KMNYVNRY9UftEqTq7cg\"",
  "timestamp": "2020-11-26T14:07:41.209Z"
}

{
    "eventId": "7b114275-7c29-4446-9a70-75c7d63b5eb0",
    "accountId": 1234,
    "apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385",
    "name": "message.inbound",
    "payload": {
        "from": {
            "phoneNumber": "447123123123",
            "whatsApp": {
                "whatsAppId": "447123123123",
                "name": "Tom Smith"
            },
            "phoneNumberCountryCode": "GB",
            "profileId": "anon_7b1302b0-4433-439e-bfb2-94e5daf21f9c"
        },
        "channel": "whatsApp",
        "to": {
            "phoneNumber": "447700600000"
        },
        "messageParts": [
            {
                "url": "https://content-cpaas.dotdigital.com/apispaces/61d1780d-8440-480a-b268-20b1eb50a4ff/content/b30e4c1b-f1e3-4732-871a-5448105e4459",
                "type": "image/jpeg",
                "size": 433081
            }
        ],
        "receivedOn": "2020-11-26T14:06:47.017Z",
        "correlation": {
            "messageId": "85bf4ea4-8791-4c97-b9c5-4922f66c4b6f"
            }
        },
        "id": "17d4d626-5ecf-425e-bcd5-b06ec69059ea"
    },
    "revision": 0,
    "etag": "\"2e-jml3dXIWbyN3/zVVni/owGx71bQ\"",
    "timestamp": "2020-11-26T14:06:47.018Z"
}

{
  "eventId": "54d06950-a1ed-46d6-b900-22b6e1aa2055",
  "accountId": 32753,
  "apiSpaceId": "61d1780d-8440-480a-b268-20b1eb50a4ff",
  "name": "message.inbound",
  "payload": {
    "from": {
      "phoneNumber": "447123123123",
      "whatsApp": {
        "whatsAppId": "447123123123",
        "name": "Tom Smith"
      },
      "phoneNumberCountryCode": "GB",
      "profileId": "anon_c791e170-d091-4ee2-a34d-1086f3da2717"
    },
    "channel": "whatsApp",
    "channelData": {
      "whatsApp": {
        "isCloudOriginator": true
      }
    },
    "to": {
      "phoneNumber": "447700600000"
    },
    "messageParts": [
      {
        "type": "text/plain",
        "data": "Not yet"
      },
      {
        "type": "whatsapp/button-reply",
        "data": {
          "payload": "Not yet",
          "text": "Not yet"
        }
      }
    ],
    "receivedOn": "2025-10-23T17:21:36.991Z",
    "body": "Not yet",
    "correlation": {
      "messageId": "bb611eca-8ccd-468e-b694-ec81194ba9c2"
    },
    "id": "35d36678-93eb-4dab-b06b-89b49afde045",
    "_apiSpaceId": "ff42e8af-5fc3-40d4-a38c-034535c0a385"
  },
  "revision": 0,
  "etag": "\"2e-Upw4I7OKbJHok4xR7nZNsgiyK1k\"",
  "timestamp": "2025-10-23T17:21:37.025Z"
}

Complaint.received

This event informs you that a complaint has been received about your messaging.

Examples

{
    "eventId": "a8006e0c-1f1e-4f72-933b-210a916b9ca9",
    "name": "complaint.received",
    "revision": 1,
    "apiSpaceId": "c224cf6e-4352-4b26-a71a-c9032bea7a01",
    "accountId": 1234,
    "etag": "\"43-W4RaAjC/OA3XyemBq6TKoFzWPXI\"",
    "payload": {
        "id": "03804b7d-50ae-4460-add0-606d8621628d",
        "subject": {
            "email": "iam.unhappy@emailsim.com"
        },
        "receivedOn": "2021-10-19T15:09:48.020Z",
        "complaintDetails": {
            "reason": "Complained to ISP"
        },
        "additionalData": {
            "campaignTags": null
        },
        "correlation": {
            "channel": "transactionalEmail",
            "to": {
                "email": "iam.unhappy@emailsim.com"
            },
            "messageId": "03804b7d-50ae-4460-add0-606d8621628d",
            "metadata": {
                "myIdentifier": "abc5",
                "customField": "A value"
            }
        }
    },
    "timestamp": "2021-10-19T15:09:48.020Z"
}

Interaction.click

This event is used to pass information about interactions with tracked links, button presses etc...

Examples

{
  "eventId": "95a47bdb-c50b-4945-ab3c-e22ffc4e69bf",
  "name": "interaction.click",
  "revision": 1,
  "apiSpaceId": "c224cf6e-4352-4b26-a71a-c9032bea7a01",
  "accountId": 1234,
  "etag": "\"34-WuocCAxmf1AQJEIBrFA+QtBmYXg\"",
  "payload": {
    "id": "http://www.dotdigital.com",
    "type": "linkClick",
    "interactionTime": "2021-10-13T13:09:24.414Z",
    "interactionMetadata": {
      "ip": "127.0.0.1",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/94.0.4606.71 Safari/537.36",
      "campaignTags": [
        "registration",
        "transactional"
      ],
      "campaignId": 321,
      "linkGroups": [
        "Group1"
      ],
      "linkName": "Link1"
    },
    "correlation": {
      "channel": "transactionalEmail",
      "to": {
        "toAddresses": "joe.bloggs@emailsim.io,jo.bloggs@acme.com",
        "ccAddresses": null,
        "bccAddresses": null
      },
      "messageId": "3bc96422-1cba-4958-b667-b016ac3355b1",
      "metadata": {
        "metaData1": "data"
      }
    }
  },
  "timestamp": "2021-10-13T13:09:24.414Z"
}

{
  "eventId": "bcf980f4-457d-490f-a156-2a225ac89707",
  "accountId": 12345,
  "apiSpaceId": "134baba6-a68d-4ebe-9110-5567e7ca3b25",
  "name": "interaction.click",
  "payload": {
    "id": "https://dotdigital.com#link2",
    "type": "linkClick",
    "interactionTime": "2022-02-03T16:12:12.898Z",
    "interactionMetadata": {
      "ip": "192.249.88.125",
      "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36 Google-PageRenderer Google (+https://developers.google.com/+/web/snippet/)"
    },
    "correlation": {
      "to": {
        "phoneNumber": "44123123123"
      },
      "channel": "sms",
      "messageId": "f0d962dd-89d8-49d3-998e-123f5bc02927",
      "conversationId": "my conv id",
      "metadata": {
        "data": "My correlation data",
        "moreData": "You can hold any structured JSON data!"
      }
    }
  },
  "revision": 1,
  "etag": "\"28-MHKb1s+iiK+aWpeMwlh4lGW+uiM\"",
  "timestamp": "2022-02-03T16:12:17.415Z"
}

{
  "eventId": "74564da1-ea60-49ae-81e4-933581f4be8f",
  "accountId": 12345,
  "apiSpaceId": "134baba6-a68d-4ebe-9110-5567e7ca3b25",
  "name": "interaction.click",
  "payload": {
    "id": "https://dotdigital.com",
    "type": "linkClick",
    "interactionTime": "2022-11-28T09:54:42.401Z",
    "interactionMetadata": {
      "ip": "192.168.0.1",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36"
    },
    "correlation": {
      "to": {
        "phoneNumber": "447123123123"
      },
      "channel": "sms",
      "messageId": "74add15e-0c29-4198-a25b-2c08b3de9a82",
      "conversationId": null,
      "metadata": {
        "useraccountid": 9123123,
        "campaignid": 0,
        "contactid": 45697009,
        "requestid": 12650,
        "sendid": 15357853,
        "programid": 134
      }
    }
  },
  "revision": 1,
  "etag": "\"22-Raw+xJBn/+gCzcHXj8upEm26Q7I\"",
  "timestamp": "2022-11-28T09:55:17.344Z"
}