Cadastrar webhook

POST/api/webhooks

Esse endpoint permite que um originador autenticado cadastre uma URL para recebimento de webhooks.

Dados da requisição

Observação

Recomendamos utilizar uma URL HTTPS pública e altamente disponível.

Campo	Tipo	Descrição	Obrigatório
url	string	URL de destino que receberá os eventos.	Sim
event	string	Evento único a assinar.	Sim

Exemplo de body (JSON)

{
  "url": "https://example.com/webhooks",
  "event": "operation.approved"
}

Exemplos de resposta

201 - Sucesso

{
  "id": "0198c88c-e5c1-7274-9482-da020efb6f99",
  "event": "operation.approved",
  "url": "https://example.com/webhooks",
  "active": true,
  "createdAt": "2025-08-20T17:35:33.825Z",
  "updatedAt": "2025-08-20T17:35:33.825Z"
},

400 - Requisição inválida

{
  "message": "Validation error.",
  "errors": [
    { "field": "url", "message": "URL is invalid." },
    { "field": "event", "message": "Invalid value." }
  ]
}

Campos da resposta de sucesso

Campo	Tipo	Descrição
url	string	URL cadastrada para recebimento dos eventos.
event	string	Evento assinado.
active	boolean	Indica se o webhook está ativo.
createdAt	string	Data/hora de criação em ISO 8601 (UTC).
updatedAt	string	Data/hora da última atualização em ISO 8601 (UTC).