Pular para o conteúdo
POST/webhooks/{id}/testar

Mandar um evento de teste

webhooks:geriraceita Idempotency-Key

POST /webhooks/{id}/testar

curl -X POST "https://chat.forsi.com.br/api/v1/webhooks/506b7dac-d0bc-4954-8d45-0015588d64b5/testar" \
  -H "Authorization: Bearer $FORSI_CHAVE" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: pedido-4821" \
  -d '{}'
Resposta 202
{"dados":{"entrega_id":"4a989b41-b6e1-414a-ba98-158a58f4195d"}}

Parâmetros no caminho#

  • iduuidobrigatório

    No caminho da URL.

Corpo da requisição#

JSON, opcional. Mande com Content-Type: application/json.

Sem campos: mande {} ou nenhum corpo.

Resposta#

202 com {"dados": ...}: TesteAceito.

  • entrega_iduuidopcional
    —

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.
409Conflito (repetido, Idempotency-Key com outro corpo).
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.