Entregas que falharam

GET /webhooks/{webhook_id}/failures

Lista as entregas que falharam de vez (depois das novas tentativas) nas últimas 24 horas, da mais nova para a mais antiga.

Só message.received e message.sent ficam guardados (são os que se remontam da mensagem salva): a falha dos outros eventos, inclusive message.status e message.failed, conta só em health. Para reenviar, use POST /webhooks/resends.

Autenticação

[
  {
    "token": []
  }
]

{
  "token": {
    "name": "token",
    "type": "apiKey",
    "in": "header"
  }
}

Parâmetros

[
  {
    "name": "webhook_id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string"
    },
    "description": "O `id` do webhook."
  },
  {
    "name": "limit",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200,
      "default": 50
    },
    "description": "Itens por página (1 a 200; padrão 50)."
  },
  {
    "name": "cursor",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "description": "O `next_cursor` da página anterior. Sem ele, vem a primeira página."
  }
]

Respostas

{
  "200": {
    "description": "As falhas.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "failures"
          ],
          "properties": {
            "failures": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/WebhookFailure"
              }
            },
            "next_cursor": {
              "type": "string",
              "description": "Cursor da próxima página: mande em `cursor`. Ausente na última página."
            }
          }
        },
        "example": {
          "failures": [
            {
              "event_type": "message.received",
              "message_id": "3EB0A1B2C3D4E5F60718",
              "status_code": 503,
              "attempts": 4,
              "error": "503 Service Unavailable",
              "failed_at": "2026-10-17T12:00:05.000Z"
            }
          ]
        }
      }
    }
  },
  "400": {
    "description": "O webhook é da API v1 (`format: v1`): as falhas e o reenvio dele ficam nas rotas do webhook v1 (`GET /webhook/errors`).",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "invalid_request",
          "message": "Webhook v1: as falhas dele ficam no GET /webhook/errors."
        }
      }
    }
  },
  "401": {
    "description": "Token inválido ou ausente.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "unauthorized",
          "message": "Token inválido."
        }
      }
    }
  },
  "404": {
    "description": "Webhook não encontrado.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "not_found",
          "message": "Webhook não encontrado."
        }
      }
    }
  },
  "429": {
    "$ref": "#/components/responses/RateLimited"
  },
  "500": {
    "$ref": "#/components/responses/InternalError"
  }
}

Estado: Disponível

Compatibilidade de canais

CanalCompatívelObservação
WhatsApp (Web)Sim
WhatsApp (API oficial)Sim
InstagramSim
MessengerSim
TelegramSim

Eventos que esta rota gera

Nenhum. Esta rota não gera evento no webhook (nem em GET /events): o resultado vem só na resposta.

Antes e depois (uazapi → Orkesio)

Na uazapi: GET /webhook/errors.

  • Por webhook, na rota dele, com cursor (antes, uma lista só com as falhas de todos os webhooks da inbox). created → failed_at, messageid → message_id, event → event_type (nome da Orkesio).

#/components/schemas/WebhookFailure

{
  "type": "object",
  "properties": {
    "event_type": {
      "type": "string",
      "description": "O evento que não foi entregue (`message.received`, `message.sent`...)."
    },
    "message_id": {
      "type": "string",
      "description": "Id da mensagem na Orkesio (o `data.message.id` do evento), para buscá-la."
    },
    "status_code": {
      "type": "integer",
      "description": "Status HTTP que o destino respondeu (0 sem resposta)."
    },
    "attempts": {
      "type": "integer",
      "description": "Tentativas feitas: a primeira mais as novas (`retries`)."
    },
    "error": {
      "type": "string",
      "description": "O motivo: o status HTTP ou a falha de conexão (até 200 caracteres)."
    },
    "stage": {
      "type": "string",
      "description": "Onde falhou: `http` (o seu servidor respondeu erro), `request` (não deu para conectar ou o prazo acabou), `config` (o webhook está mal configurado), `config_load` (não deu para ler os webhooks da inbox), `serialization` (não deu para montar o corpo do evento), `disabled` (o webhook foi desligado antes de uma nova tentativa), `dispatcher`, `global_queue_full`, `connection_queue_full`, `instance_queue_full` e `history_queue_full` (a fila de envio estava cheia), `contacts_limit` (lote de contatos acima do limite) ou `shutdown` (o servidor reiniciou no meio). Ausente nas falhas antigas."
    },
    "failed_at": {
      "type": "string",
      "format": "date-time",
      "description": "Quando falhou a última tentativa. ISO 8601 em UTC com milissegundos."
    },
    "inbox_id": {
      "type": "string",
      "description": "A inbox do evento (só no webhook global)."
    }
  }
}

#/components/schemas/OrkesioError

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP."
    },
    "message": {
      "type": "string",
      "description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`."
    },
    "field": {
      "type": "string",
      "description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)."
    }
  },
  "required": [
    "error",
    "message"
  ],
  "additionalProperties": true,
  "description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)."
}

#/components/responses/RateLimited

{
  "description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.",
  "headers": {
    "Retry-After": {
      "description": "Segundos até poder chamar de novo.",
      "schema": {
        "type": "integer",
        "minimum": 1
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "rate_limited",
        "message": "Muitas requisições."
      }
    }
  }
}

#/components/responses/InternalError

{
  "description": "`internal_error`: falha inesperada na api (no banco, por exemplo); tente de novo.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "internal_error",
        "message": "Falha inesperada."
      }
    }
  }
}

Guias relacionados

Visão geral · O que funciona em cada canal · O que muda da uazapi