Webhooks

Registrar webhook

Registra um novo endpoint de webhook para receber notificações de eventos. O secret retornado na resposta é exibido apenas neste momento — armazene-o com segurança para validar as assinaturas HMAC-SHA256 dos payloads recebidos.

Uma URL que já tem um webhook ACTIVE no tenant é recusada com 409, qualquer que seja a lista de eventos; o webhookId existente vem no detail. Para mudar os eventos, remova o registro (DELETE /v1/webhooks/{webhookId}) e registre a URL de novo — o novo registro recebe um novo secret.

Requer scope webhooks:write.

post/v1/webhooks

Request

  • Base URL: https://api.signdocs.com.br
  • URL: https://api.signdocs.com.br/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required

URL do endpoint que receberá as notificações (HTTPS obrigatório).

eventsWebhookEventType[] required

Lista de tipos de evento para os quais o webhook será acionado.

Example request

{
  "url": "https://integrador.com.br/webhooks/signdocs"
}

Response

Webhook registrado com sucesso. O secret é retornado apenas nesta resposta.

webhookIdstring required
urlstring uri required
secretstring required

Segredo HMAC-SHA256 para validação de payloads. Exibido apenas na criação.

eventsWebhookEventType[] required
status'ACTIVE' required
createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.