messageFailed\
Required token scopes:
Create scenariosManage scenarios on behalf of user
Subscribe
Send the body below to Import Subscription. You only need to change:url(required) - Located underdata.actions[0].params.url. Replace{{yourWebhookURL}}with the destination URL that should receive the events.asStatus- Keep"active"to enable the subscription immediately, or"inactive"to save it as an inactive revision.
Import body
A
201 response returns your new subscription - save its _id to manage it later. You can also add an optional authorUid root field (a Texter user UID) to attribute the subscription to a specific user.Payload
When the event fires, your URL receives an HTTPPOST with eventName: "messageFailed" and the following eventData:
The chat associated with the failed message. See the Chat object for all fields.
The error message or code received from the provider.
When the failure occurred (Unix epoch milliseconds).
Unique IDs assigned to the message(s) by the external provider (e.g. WhatsApp
wamid...).Example payload
How to identify the message
Because this event is triggered by the external provider (e.g. Meta/WhatsApp), the payload does not contain the internalmessage._id. Instead, it provides the externalId. To find the specific message in your system:
- Take the
_idfrom thechatobject in the payload. - Call Get Messages of a Chat.
- Find the message whose
channelInfo.idmatches one of the values in theexternalIdarray.
Manage this subscription
| Action | Endpoint |
|---|---|
| List subscriptions | List All Subscriptions |
| Pause | Inactivate Subscription |
| Resume | Activate Subscription |
| Delete | Delete Subscription |
| Debug executions | List Scenario Runs |