Skip to Content
WebhooksCriar webhook

Criar webhook

POST/v1/webhooks
🔒 Requer Bearer token

Escopo webhooks:write. Retorna o secret HMAC (exibido só na criação). Eventos disponíveis: autorizacao.confirmada, margem.concluida, margem.falhou, assinatura.concluida, averbacao.concluida, averbacao.falhou, desembolso.liquidado, desembolso.falhou.

Corpo da requisição
urlstring<uri>obrigatório
eventosarray<string>obrigatório
Respostas
201Webhook criado; `secret` HMAC exibido só aqui.
400Dados inválidos (`ERRO_VALIDACAO`).
401Token ausente ou inválido (`CREDENCIAL_INVALIDA`).
Request
curl -X POST 'http://localhost:3101/v1/webhooks' \
  -H 'Authorization: Bearer SEU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "string",
  "eventos": [
    "autorizacao.confirmada"
  ]
}'
Response
{
  "id": "b3d9f0a1-2c34-4e56-8a90-1b2c3d4e5f60",
  "url": "https://parceiro.com.br/webhooks/socinal",
  "eventos": [
    "averbacao.concluida",
    "desembolso.liquidado"
  ],
  "ativo": true,
  "criado_em": "2026-06-20T13:45:00.000Z",
  "secret": "whsec_3f1c8a90b2d4e6f81234567890abcdef1234567890abcdef1234567890abcdef"
}