collections

Criar ou atualizar uma assinatura de webhook

Cria (sem id) ou atualiza (com id) uma assinatura de webhook. A mesma assinatura pode escutar eventos do Onboarding e eventos de relatorio e credito.

Quando os eventos de relatorio e credito nao puderem ser gravados (o endereco precisa responder a um POST de teste no momento do cadastro), a resposta continua 200 e traz warning com o motivo.

LISTA DE EVENTOS VAZIA QUER DIZER TODOS. Quem esta comecando nao sabe de quais precisa, e escolher antes de conhecer produz assinatura errada e evento perdido em silencio.

O segredo e gerado pela plataforma e devolvido UMA VEZ, na criacao. Ele e por assinatura: um endpoint comprometido nao permite forjar evento para os outros.

A URL precisa ser publica; endereco interno e recusado, e o nome e resolvido de novo a cada tentativa de entrega.

Confira a assinatura com HMAC_SHA256(segredo, "<X-Gyra-Timestamp>.<corpo cru>") e recuse o que estiver fora de uma janela de cinco minutos.

post/v1/webhook/endpoints

Request

  • Base URL: https://gyra-core.gyramais.com.br
  • URL: https://gyra-core.gyramais.com.br/v1/webhook/endpoints
  • Auth: HTTP bearer

Request body

idstring

Ausente cria; presente atualiza.

urlstring required

URL publica, http ou https, com dominio.

labelstring

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

eventsstring[]

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

enabledboolean

Religar zera o contador de falhas seguidas.

apiKeystring

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

Example request

{
  "url": "https://api.suaempresa.com/gyra/webhook"
}

Response

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

idstring
urlstring
labelstring nullable
eventsstring[]
enabledboolean
secretHintstring
secretstring

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

warningstring

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

createdAtstring date-time
updatedAtstring date-time

Changes

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