> ## Documentation Index
> Fetch the complete documentation index at: https://help.texterchat.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Messages Failed to Deliver

> Fires when an outgoing message fails to deliver

ubscribe to receive a notification whenever an outgoing message fails to deliver (status code 4 or 5) - for example blocked by Meta/WhatsApp, invalid number, or network failure.

**Event name:** `messageFailed`\\

**Required token scopes:**

* `Create scenarios`
* `Manage scenarios on behalf of user`

see [Authentication](/he/api-reference/authentication)

## Subscribe

Send the body below to [Import Subscription](/he/api-reference/subscribe-to-events/import-subscription-subscribe-to-an-event). You only need to change:

* **`url`** *(required)* - Located under `data.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.

```json Import body [expandable]  theme={null}
{
  "data": {
    "version": "v1",
    "name": "(SUB) Messages Failed to Deliver",
    "description": "Sends a webhook when an outgoing message fails to deliver (blocked by Meta)",
    "triggerEvents": [
      "app.message.statusRequest"
    ],
    "loaders": {
      "afterConditions": [
        {
          "name": "chat",
          "alias": "chat",
          "params": {
            "name": {
              "##provide": {
                "provider": "messageStatusRequest",
                "key": "chat.name"
              }
            },
            "accountId": {
              "##provide": {
                "provider": "messageStatusRequest",
                "key": "chat.accountId"
              }
            },
            "idByChannel": {
              "##provide": {
                "provider": "messageStatusRequest",
                "key": "chat.id"
              }
            }
          },
          "confidentialData": false
        }
      ]
    },
    "conditions": [
      [
        {
          "name": "compare",
          "params": {
            "comparison": "Equal",
            "compareTo": 4,
            "value": {
              "##provide": {
                "provider": "messageStatusRequest",
                "key": "status"
              }
            }
          },
          "confidentialData": false
        }
      ],
      [
        {
          "name": "compare",
          "params": {
            "comparison": "Equal",
            "compareTo": 5,
            "value": {
              "##provide": {
                "provider": "messageStatusRequest",
                "key": "status"
              }
            }
          },
          "confidentialData": false
        }
      ]
    ],
    "actions": [
      {
        "name": "request",
        "params": {
          "url": "{{yourWebhookURL}}",
          "method": "post",
          "json": true,
          "data": {
            "eventName": "messageFailed",
            "eventData": {
              "chat": {
                "##provide": {
                  "provider": "chat",
                  "key": "chat"
                }
              },
              "error": "%messageStatusRequest:error%",
              "timestamp": "%messageStatusRequest:timestamp%",
              "externalId": "%messageStatusRequest:ids%"
            }
          }
        },
        "confidentialData": false
      }
    ],
    "options": {
      "unorderedActions": false
    }
  },
  "asStatus": "active"
}
```

<Note>
  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.
</Note>

## Payload

When the event fires, your URL receives an HTTP `POST` with `eventName: "messageFailed"` and the following `eventData`:

<ResponseField name="chat" type="Chat">
  The chat associated with the failed message. See the [Chat object](/he/api-reference/objects/chat) for all fields.
</ResponseField>

<ResponseField name="error" type="string">
  The error message or code received from the provider.
</ResponseField>

<ResponseField name="timestamp" type="number">
  When the failure occurred (Unix epoch milliseconds).
</ResponseField>

<ResponseField name="externalId" type="string[]">
  Unique IDs assigned to the message(s) by the external provider (e.g. WhatsApp `wamid...`).
</ResponseField>

```json Example payload  theme={null}
{
  "eventName": "messageFailed",
  "eventData": {
    "chat": {
      "_id": "69072b0233aea8a47f8bad9f",
      "hasMessageError": true,
      "title": "972521234567",
      "...": "..."
    },
    "error": "Message undeliverable\nMessage Undeliverable.",
    "timestamp": 1768141074000,
    "externalId": [
      "wamid.HBgMOTcyNTIxMjM0NTY3FQIAERgSMDhGRTVGNEY1MTA0Q0NBMzNEAA=="
    ]
  }
}
```

### How to identify the message

Because this event is triggered by the external provider (e.g. Meta/WhatsApp), the payload does **not** contain the internal `message._id`. Instead, it provides the `externalId`. To find the specific message in your system:

1. Take the `_id` from the `chat` object in the payload.
2. Call [Get Messages of a Chat](/he/api-reference/messages/get-messages-of-a-chat).
3. Find the message whose `channelInfo.id` matches one of the values in the `externalId` array.

## Manage this subscription

| Action             | Endpoint                                                                                 |
| ------------------ | ---------------------------------------------------------------------------------------- |
| List subscriptions | [List All Subscriptions](/he/api-reference/subscribe-to-events/list-all-subscriptions)   |
| Pause              | [Inactivate Subscription](/he/api-reference/subscribe-to-events/inactivate-subscription) |
| Resume             | [Activate Subscription](/he/api-reference/subscribe-to-events/activate-subscription)     |
| Delete             | [Delete Subscription](/he/api-reference/subscribe-to-events/delete-subscription)         |
| Debug executions   | [List Scenario Runs](/he/api-reference/scenarios-advanced/list-scenario-runs)            |