Criar Webhook

Configurar Webhook da Organização

post

https://api.staging.scr.gtbanker.com.br/apihttps://api.scr.gtbanker.com.br/api

/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

bearerAuth

Corpo

application/json

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.

400

URL inválida ou dados incompletos.

application/json

post

/webhooks

HTTPcURLJavaScriptPython

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

Central de Atendimento | Giro.TechGiro.Tech