Registrar webhook

Sandbox

http://localhost:4500/api/v1

POST

/webhooks

Registra uma URL para receber os eventos da sua empresa. O secret retorna
apenas nesta resposta — guarde-o para validar a assinatura HMAC.
Em produção a URL deve ser https e não pode apontar para endereços internos.
Limite: 10 webhooks ativos por empresa.

Requisição

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Criado

application/json

Webhook criado (única resposta com o secret)

Bodyapplication/json

🟠422Erro de Parâmetro

Request Example

Shell

JavaScript

Java

Swift

curl --location 'http://localhost:4500/api/v1/webhooks' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://api.parceiro.com.br/nexxus/webhook",
    "descricao": "Notificações do CRM",
    "eventos": [
        "proposta.criada",
        "proposta.fase_alterada",
        "proposta.pendencia_criada",
        "proposta.pendencia_resolvida"
    ]
}'

Response Example

201 - Exemplo de Sucesso

{
    "id": 1,
    "url": "https://api.parceiro.com.br/nexxus/webhook",
    "descricao": "Notificações do CRM",
    "eventos": [
        "proposta.criada",
        "proposta.fase_alterada",
        "proposta.pendencia_criada",
        "proposta.pendencia_resolvida"
    ],
    "ativo": true,
    "secret": "whsec_9f5f78e3f37f1eb9...",
    "criado_em": "2026-07-08T00:47:45.000Z"
}

Modificado em 2026-07-08 01:52:25

Página anterior

Status em tempo real (SSE)

Próxima página

Listar webhooks