Registrar webhook

POST /webhooks

Request

{
  "credentialId": "8f14e0a1-2b3c-4d5e-9f01-abcdef123456",
  "url": "https://partner.example.com/webhook",
  "description": "Integração ERP",
  "eventTypes": ["profile_analysis.finished", "contract.signature.finished"]
}

Campo	Tipo	Obrigatório	Regras
`credentialId`	string	Sim	Id de uma credencial do próprio parceiro
`url`	string	Sim	URL HTTPS que receberá os eventos
`description`	string	Não	Texto livre
`eventTypes`	array	Sim	Não vazio; códigos de `GET /webhooks/event-types` com `subscribable: true`

Sucesso — 201 Created

{
  "id": "c4d5e6f7-8901-2345-6789-abcdef012345",
  "credentialId": "8f14e0a1-2b3c-4d5e-9f01-abcdef123456",
  "url": "https://partner.example.com/webhook",
  "description": "Integração ERP",
  "status": "ACTIVE",
  "consecutiveFailures": 0,
  "eventTypes": ["profile_analysis.finished", "contract.signature.finished"],
  "createdAt": "2026-09-16T12:34:56Z",
  "updatedAt": "2026-09-16T12:34:56Z"
}

`status`	Significado
`ACTIVE`	Recebendo entregas normalmente
`SUSPENDED`	Suspenso por falhas consecutivas — reativado por `PATCH`, por um ping bem-sucedido ou por uma entrega bem-sucedida
`REVOKED`	Revogado permanentemente — nunca mais recebe entregas