Pular para o conteúdo
GET/webhooks/{id}/entregas

Histórico de entregas

webhooks:gerir

50 por página, da mais nova para a mais antiga, com o corpo enviado e a resposta.

GET /webhooks/{id}/entregas

curl "https://chat.forsi.com.br/api/v1/webhooks/506b7dac-d0bc-4954-8d45-0015588d64b5/entregas?estado=falhou" \
  -H "Authorization: Bearer $FORSI_CHAVE"
Resposta 200
{
  "dados": [
    {
      "id": "4a989b41-b6e1-414a-ba98-158a58f4195d",
      "webhook_id": "506b7dac-d0bc-4954-8d45-0015588d64b5",
      "evento": "mensagem.recebida",
      "evento_id": "5e458e2a-2f89-4c56-8f5e-f6bfa9ef0a35",
      "estado": "pendente",
      "tentativas": 1,
      "status_http": 200,
      "resposta": "ok",
      "erro": "Connection timed out",
      "duracao_ms": 182,
      "criado_em": "2026-10-04T13:05:12.481Z",
      "ultima_tentativa_em": "2026-10-04T13:05:12.481Z",
      "proxima_em": "2026-10-04T13:05:12.481Z",
      "entregue_em": "2026-10-04T13:05:12.481Z",
      "payload": {
        "id": "5e458e2a-2f89-4c56-8f5e-f6bfa9ef0a35",
        "evento": "mensagem.recebida",
        "criado_em": "2026-10-04T13:05:12.481Z",
        "organizacao_id": "dddecb67-6b55-43da-94f6-18c8d6680571",
        "dados": {
          "mensagem": {
            "id": "4e8cb5d0-2d89-4fc2-93bb-c8e5e17d4629",
            "conversa_id": "495a7cae-128c-4b66-adbc-807b3959c129",
            "direcao": "entrada",
            "tipo": "texto",
            "texto": "Oi, queria remarcar minha consulta",
            "autor_tipo": "contato",
            "criado_em": "2026-10-04T13:05:11.902Z"
          },
          "conversa": {
            "id": "495a7cae-128c-4b66-adbc-807b3959c129",
            "estado": "aberta",
            "caixa_id": "7a9d53e9-9d1b-4122-923b-fac67958f445"
          },
          "contato": {
            "id": "08054a7f-a752-481e-9915-cf4cf944df39",
            "nome": "Maria Souza",
            "telefone": "+5531988887777"
          }
        }
      }
    }
  ]
}

Parâmetros no caminho#

  • iduuidobrigatório

    No caminho da URL.

Parâmetros de consulta#

  • estado"pendente" | "falhou" | "entregue" | "morta" | "cancelada"opcional
    —
  • antesuuidopcional

    Id da última entrega vista (página seguinte).

Resposta#

200 com {"dados": ...}: uma lista de Entrega.

  • iduuidopcional
    —
  • webhook_iduuidopcional
    —
  • eventostringopcional
    —
  • evento_iduuidopcional
    —
  • estado"pendente" | "falhou" | "entregue" | "morta" | "cancelada"opcional
    —
  • tentativasintegeropcional
    —
  • status_httpinteger ou nullopcional
    —
  • respostastring ou nullopcional
    —
  • errostring ou nullopcional
    —
  • duracao_msinteger ou nullopcional
    —
  • criado_emdata e hora ISO 8601opcional
    —
  • ultima_tentativa_emdata e hora ISO 8601 ou nullopcional
    —
  • proxima_emdata e hora ISO 8601 ou nullopcional
    —
  • entregue_emdata e hora ISO 8601 ou nullopcional
    —
  • payloadEventoopcional
    —

Erros#

Todo erro vem como {"erro": {"codigo", "mensagem"}}. Trate pelo codigo: ele não muda.

Status de erro desta operação
StatusQuando
401Chave ausente ou inválida (resposta igual para qualquer motivo).
403Plano sem API, escopo insuficiente ou https/origem recusados.
404Não existe nesta organização.
422Dados inválidos ou regra de negócio (ex.: janela_fechada; conta_restrita = a Meta restringiu a conta por spam: erro traz os campos de RestricaoMeta, como ate, escopo, motivo e retry_after_s).
429Limite de requisições. Veja Retry-After.
Códigos de erro que esta área pode devolver12
  • webhook_inexistenteWebhook não encontrado.
  • entrega_inexistenteEntrega não encontrada.
  • webhook_desativadoEste webhook está desativado. Reative com PATCH {"ativo": true}.
  • entrega_em_andamentoEsta entrega ainda está em andamento.
  • entrega_ja_despachadaEsta entrega já saiu uma vez e não é repetida (entrega única, sem duplicar). Só entregas que nunca saíram podem ser reenviadas.
  • url_invalidaURL inválida: use https://, porta 443 e um nome de domínio público.
  • destino_bloqueadoEsse endereço aponta para uma rede interna ou reservada. Use um endereço público.
  • dns_falhouNão conseguimos resolver esse domínio. Confira o endereço.
  • eventos_invalidosAlgum evento não existe. Veja a lista na documentação.
  • limite_de_webhooksLimite de 10 webhooks por organização.
  • nome_invalidoNome deve ter de 1 a 60 caracteres.
  • graca_invalidahoras deve ser de 0 a 168.

Os erros que valem para qualquer rota (chave, limite, JSON) estão em Erros.