Skip to main content
POST
cURL

Quando usar

Para assinar os eventos do módulo e parar de fazer polling.

Lista de eventos vazia quer dizer todos

Quem está começando não sabe de quais precisa, e escolher antes de conhecer produz assinatura errada e evento perdido em silêncio.

O segredo aparece uma vez

Ele volta em claro só nesta resposta, na criação e na rotação. Confira a assinatura com HMAC_SHA256(segredo, "<X-Gyra-Timestamp>.<corpo cru>") e recuse o que estiver fora de uma janela de cinco minutos.
Contexto e vocabulário em Eventos de webhook. Autenticação, versionamento e capacidades em Visão geral da API.

Authorizations

Authorization
string
header
required

Enter JWT token

Body

application/json
url
string
required

URL publica, http ou https, com dominio.

Example:

"https://api.suaempresa.com/gyra/webhook"

id
string

Ausente cria; presente atualiza.

label
string

Como a assinatura aparece na tela. Na atualizacao, omitir mantem o atual; string vazia limpa.

Maximum string length: 80
events
string[]

Vazio ou ausente quer dizer TODOS os eventos, inclusive os de relatorio e credito. Sem repeticao.

enabled
boolean

Religar zera o contador de falhas seguidas.

apiKey
string

Valor enviado no cabecalho api-key, so nos eventos de relatorio e credito (esses nao usam a assinatura HMAC).

Response

Assinatura salva. Na criacao e na rotacao, inclui o secret em claro (unica vez).

id
string
url
string
label
string | null
events
string[]
enabled
boolean
secretHint
string
secret
string

O segredo em claro, no formato whsec_ seguido de 64 caracteres hexadecimais. SO VEM AQUI, na criacao e na rotacao. Guarde no seu cofre.

warning
string

Presente so quando os eventos de relatorio e credito nao foram salvos; diz o motivo.

createdAt
string<date-time>
updatedAt
string<date-time>