Pular para o conteúdo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Criar Webhook

Configurar Webhook da Organização

post
/webhooks

Define a URL e o Segredo para onde a API deve enviar os callbacks (notificações de sucesso, erro ou assinatura de documentos). Apenas um webhook pode ser configurado por organização (sobrescreve o anterior).

Autorizações
Corpo
payloadUrlstring · uriObrigatório

URL HTTPS onde a notificação será entregue (POST).

Example: https://minhaempresa.com.br/api/callback/scr
secretstringObrigatório

Token ou chave secreta enviada no Header 'Authorization' da notificação para validar a origem.

Example: my-secret-key-123
Respostas
201

Webhook configurado com sucesso.

Sem conteúdo

post/webhooks
POST /api/webhooks HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "payloadUrl": "https://minhaempresa.com.br/api/callback/scr",
  "secret": "my-secret-key-123"
}

Sem conteúdo

Atualizado