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, emprestimo.emitido, emprestimo.emissao_falhou, assinatura.concluida, assinatura.pendente, averbacao.concluida, averbacao.falhou, desembolso.liquidado, desembolso.falhou, docs_dataprev.pendente, docs_dataprev.recebido, trabalhador.desligado, trabalhador.vinculo_novo, repasse.processado, repasse.pago, autorizacao.expirada.

Corpo da requisição

urlstring<uri>obrigatório

eventosarray<string>obrigatório

autorizacao.confirmadamargem.concluidamargem.falhouemprestimo.emitidoemprestimo.emissao_falhouassinatura.concluidaassinatura.pendenteaverbacao.concluidaaverbacao.falhoudesembolso.liquidadodesembolso.falhoudocs_dataprev.pendentedocs_dataprev.recebidotrabalhador.desligadotrabalhador.vinculo_novorepasse.processadorepasse.pagoautorizacao.expirada

Respostas

Corpo da resposta 201

idstring<uuid>obrigatório

urlstring<uri>obrigatório

eventosarray<string>obrigatório

ativobooleanobrigatório

criado_emstring<date-time>obrigatório

secretstringobrigatório

Request

curl -X POST 'https://econsignado-api.socinal.com.br/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"
}