Skip to main content
A página Webhooks do plugin Bank Transfer registra os endpoints que recebem os eventos do Bank Transfer. Ela também lista as entregas que falharam. Para os eventos, a assinatura e o cronograma de novas tentativas, veja Webhooks. Cada tela do Bank Transfer precisa da permissão bank-transfer: get para vê-la, post para agir nela, patch para alterar as configurações e o documento de roteamento, e delete para excluir um webhook. Nesta página, Registrar webhook, Rotacionar segredo de assinatura e Tentar entrega novamente precisam de post. Editar, Ativar e Desativar precisam de patch. Excluir precisa de delete.

​
Acessando a página

1

Abrir o Bank Transfer

Na barra lateral do Midaz Module, expanda Bank Transfer.
2

Clicar em Webhooks

Selecione Webhooks no submenu.
A página tem duas abas: Registros e Entregas com falha.

​
Registros

A aba Registros lista os seus registros de webhook, 10 por página.

​
Registrar um webhook

1

Abrir o formulário

Clique em Registrar webhook.
2

Preencher os campos

  • Nome: um nome para o registro.
  • URL do endpoint: a URL que recebe os eventos.
  • Ativado: ligado por padrão.
  • Tipos de evento: os eventos a receber. Deixe a lista vazia para receber todos os eventos.
3

Salvar

Clique em Salvar.
4

Copiar o segredo de assinatura

O diálogo Segredo de assinatura mostra o segredo uma única vez. Copie-o antes de clicar em Já salvei. Use o segredo para verificar a assinatura de cada entrega.
Se a cópia falhar, selecione o segredo e copie-o manualmente antes de fechar o diálogo. Se o diálogo não mostrar nenhum segredo, o plugin já disponibilizou esse segredo uma vez. Rotacione o segredo de assinatura para obter um novo.

​
Editar um webhook

Clique em Editar nas ações da linha. Altere os campos e clique em Salvar. O Console envia somente os campos que você alterar.

​
Ativar ou desativar um webhook

Clique em Desativar nas ações da linha de um webhook ativado, ou em Ativar nas ações da linha de um webhook desativado.

​
Rotacionar o segredo de assinatura

1

Iniciar a rotação

Clique em Rotacionar segredo de assinatura nas ações da linha.
2

Confirmar

Clique em Rotacionar segredo de assinatura no diálogo.
3

Copiar o novo segredo

O diálogo Segredo de assinatura mostra o novo segredo uma única vez, como no registro.
A rotação invalida o segredo atual na hora. As entregas falham na verificação até você publicar o novo segredo.

​
Excluir um webhook

Clique em Excluir nas ações da linha e confirme.

​
Entregas com falha

A aba Entregas com falha lista os eventos que o plugin não conseguiu entregar depois das novas tentativas automáticas, 50 por página. Quando o plugin não expõe as rotas de entregas com falha, a aba mostra a mensagem do plugin no lugar da lista.

​
Tentar uma entrega novamente

1

Iniciar a nova tentativa

Clique em Tentar entrega novamente nas ações da linha.
2

Confirmar

Clique em Tentar entrega novamente no diálogo. O endpoint pode receber o evento mais de uma vez.
Se o plugin recusar a nova tentativa porque a entrega atingiu o máximo de novas tentativas manuais, Tentar entrega novamente fica indisponível nessa linha. A dica dela informa Número máximo de tentativas manuais atingido.

​
Páginas relacionadas

Webhooks

Eventos, verificação de assinatura e o cronograma de novas tentativas.

Guia do desenvolvedor

Código de validação de assinatura e o checklist de integração.