POST
/webhooksCriar webhook
webhooks:geriraceita Idempotency-Key
Responde com segredo UMA vez: guarde para conferir a assinatura X-Forsi-Signature. Repetir com a mesma Idempotency-Key devolve o webhook sem segredo e sem criar outro.
POST /webhooks
curl -X POST "https://chat.forsi.com.br/api/v1/webhooks" \
-H "Authorization: Bearer $FORSI_CHAVE" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: pedido-4821" \
-d '{
"nome": "CRM",
"url": "https://seu-sistema.com.br/webhooks/forsi",
"eventos": ["mensagem.recebida","mensagem.status"]
}'const resposta = await fetch('https://chat.forsi.com.br/api/v1/webhooks', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.FORSI_CHAVE}`,
'Content-Type': 'application/json',
'Idempotency-Key': 'pedido-4821',
},
body: JSON.stringify({
"nome": "CRM",
"url": "https://seu-sistema.com.br/webhooks/forsi",
"eventos": ["mensagem.recebida","mensagem.status"]
}),
});
const json = await resposta.json();
if (!resposta.ok) throw new Error(`${resposta.status} ${json.erro.codigo}: ${json.erro.mensagem}`);
console.log(json.dados);import os
import requests
resposta = requests.post(
"https://chat.forsi.com.br/api/v1/webhooks",
headers={
"Authorization": f"Bearer {os.environ['FORSI_CHAVE']}",
"Idempotency-Key": "pedido-4821",
},
json={
"nome": "CRM",
"url": "https://seu-sistema.com.br/webhooks/forsi",
"eventos": ["mensagem.recebida", "mensagem.status"],
},
timeout=30,
)
corpo = resposta.json()
if not resposta.ok:
raise RuntimeError(f"{resposta.status_code} {corpo['erro']['codigo']}: {corpo['erro']['mensagem']}")
print(corpo["dados"])Resposta 201
{
"dados": {
"id": "506b7dac-d0bc-4954-8d45-0015588d64b5",
"nome": "CRM",
"url": "https://seu-sistema.com.br/webhooks/forsi",
"eventos": ["mensagem.recebida"],
"ativo": true,
"segredo_dica": "…a1B2c3",
"segredo_anterior_ate": "2026-10-04T13:05:12.481Z",
"falhas_seguidas": 0,
"falhando_desde": "2026-10-04T13:05:12.481Z",
"desativado_em": "2026-10-04T13:05:12.481Z",
"motivo_desativacao": "falhas_seguidas",
"ultima_entrega_em": "2026-10-04T13:05:12.481Z",
"ultimo_status": 200,
"criado_em": "2026-10-04T13:05:12.481Z",
"atualizado_em": "2026-10-04T13:05:12.481Z",
"entregas_24h": {"entregues":42,"falhas":0,"pendentes":0},
"segredo": "whsec_EXAMPLE"
}
}Corpo da requisição#
JSON. Mande com Content-Type: application/json.
nomestringobrigatório- até 60 caracteres
urlstringobrigatóriohttps, porta 443, nome público (sem IP, sem rede interna).
- até 2000 caracteres
eventoslista de "mensagem.recebida" | "mensagem.enviada" | "mensagem.status" | "conversa.criada" | "conversa.atribuida" | "conversa.encerrada" | "contato.criado" | "negocio.criado" | "negocio.movido" | "negocio.ganho" | "negocio.perdido" | "agendamento.criado" | "agendamento.remarcado" | "agendamento.cancelado" | "agendamento.confirmado" | "membro.convidado" | "membro.entrou" | "membro.alterado" | "membro.removido"obrigatório- mín. 1 item
- até 19 itens
Resposta#
201 com {"dados": ...}: WebhookComSegredo.
Erros#
Todo erro vem como {"erro": {"codigo", "mensagem"}}. Trate pelo codigo: ele não muda.
| Status | Quando |
|---|---|
| 401 | Chave ausente ou inválida (resposta igual para qualquer motivo). |
| 403 | Plano sem API, escopo insuficiente ou https/origem recusados. |
| 409 | Conflito (repetido, Idempotency-Key com outro corpo). |
| 422 | Dados 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). |
| 429 | Limite 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.