Webhook - Registro

Registrar um webhook para notificações de documentos

post

http://app.staging.gtsign.giro.tech/apihttps://api.gtsign.com.br

/webhooks

Registra um webhook para receber notificações de eventos. O campo eventsType é opcional. Se não informado, será usado o padrão: SIGNATURE, DOCUMENT_FINISHED, DOCUMENT_CANCELED, ENVELOPE_FINISHED, ENVELOPE_CANCELED.

Tipos de eventos disponíveis:

• NOTIFICATION_CHANNEL: Inclui os eventos NOTIFICATION_SIGNATURE_REQUEST, NOTIFICATION_TOKEN, NOTIFICATION_SIGNATURE_CONFIRMATION, NOTIFICATION_FINISHED_DOCUMENT

• SIGNATURE: Eventos de assinatura (padrão)

• DOCUMENT_FINISHED: Documento finalizado (padrão)

• DOCUMENT_CANCELED: Documento cancelado (padrão)

• ENVELOPE_FINISHED: Envelope finalizado (padrão)

• ENVELOPE_CANCELED: Envelope cancelado (padrão)

Autorizações

jwtAuth

Corpo

application/json

payloadUrlstringObrigatório

URL pública para recebimento das chamadas do webhook via HTTPS

authKeystringObrigatório

Chave para ser usada no header de autenticação

secretstringObrigatório

Secret para ser usado no header de autenticação

Respostas

201

Webhook registrado com sucesso

Sem conteúdo

400

Erro no registro do webhook (validação de campos obrigatórios ou tipos de eventos inválidos)

post

/webhooks

HTTPcURLJavaScriptPython

POST /api/webhooks HTTP/1.1
Host: app.staging.gtsign.giro.tech
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "payloadUrl": "text",
  "authKey": "text",
  "secret": "text",
  "eventsType": [
    "NOTIFICATION_CHANNEL"
  ]
}

Sem conteúdo

Central de Atendimento | Giro.TechGiro.Tech