# POST /webhooks — Criar webhook

- URL: `POST https://chat.forsi.com.br/api/v1/webhooks`
- Acesso: escopo `webhooks:gerir` · módulo do plano: API · aceita `Idempotency-Key`
- Sucesso: `201`, `{"dados": ...}` com `WebhookComSegredo`
- Página: https://docs.forsi.com.br/api/webhooks/criar-webhook (Markdown: https://docs.forsi.com.br/api/webhooks/criar-webhook.md)

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.

**Corpo (JSON)**

| Campo | Tipo | Obrigatório | Notas |
| --- | --- | --- | --- |
| `nome` | string | sim | até 60 caracteres |
| `url` | string | sim | https, porta 443, nome público (sem IP, sem rede interna). até 2000 caracteres |
| `eventos` | lista 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" | sim | mín. 1 item até 19 itens |

**Exemplo (curl)**

```bash
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"]
  }'
```

**JavaScript (fetch)**

```js
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);
```

**Python (requests)**

```python
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` (exemplo)**

```json
{
  "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"
  }
}
```

**Erros**

- `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 comuns aqui: `webhook_inexistente`, `entrega_inexistente`, `webhook_desativado`, `entrega_em_andamento`, `entrega_ja_despachada`, `url_invalida`, `destino_bloqueado`, `dns_falhou`, `eventos_invalidos`, `limite_de_webhooks`, `nome_invalido`, `graca_invalida`.

---

Página: https://docs.forsi.com.br/api/webhooks/criar-webhook · Índice: https://docs.forsi.com.br/llms.txt · Tudo num arquivo: https://docs.forsi.com.br/llms-full.txt