> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Gerenciando webhooks

> Registre os endpoints que recebem os eventos do Bank Transfer, rotacione o segredo de assinatura deles e tente de novo as entregas com falha, pelo plugin Bank Transfer no Lerian Console.

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](/pt/interfaces/ted-jd/ted-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

***

<Steps>
  <Step title="Abrir o Bank Transfer">
    Na barra lateral do Midaz Module, expanda **Bank Transfer**.
  </Step>

  <Step title="Clicar em Webhooks">
    Selecione **Webhooks** no submenu.
  </Step>
</Steps>

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.

| Coluna | Descrição |
| - | - |
| Nome | Nome do registro. |
| Endpoint | URL que recebe os eventos. |
| Status | **Ativado** ou **Desativado**. |
| Eventos | Número de tipos de evento que o registro recebe. Quando o registro não lista nenhum tipo de evento, a coluna mostra **Todos os eventos**. |
| Atualizado | Quando o registro mudou pela última vez. |
| Ações | **Editar**, **Ativar** ou **Desativar**, **Rotacionar segredo de assinatura** e **Excluir**. |

### Registrar um webhook

<Steps>
  <Step title="Abrir o formulário">
    Clique em **Registrar webhook**.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Salvar">
    Clique em **Salvar**.
  </Step>

  <Step title="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.
  </Step>
</Steps>

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

<Steps>
  <Step title="Iniciar a rotação">
    Clique em **Rotacionar segredo de assinatura** nas ações da linha.
  </Step>

  <Step title="Confirmar">
    Clique em **Rotacionar segredo de assinatura** no diálogo.
  </Step>

  <Step title="Copiar o novo segredo">
    O diálogo **Segredo de assinatura** mostra o novo segredo uma única vez, como no registro.
  </Step>
</Steps>

<Warning>
  A rotação invalida o segredo atual na hora. As entregas falham na verificação até você publicar o novo segredo.
</Warning>

### 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.

| Coluna | Descrição |
| - | - |
| Evento | O tipo do evento. |
| Transferência | A transferência do evento. |
| Falha | Por que a entrega falhou. |
| Tentativas automáticas | Número de novas tentativas automáticas. |
| Tentativas manuais | Número de novas tentativas manuais. |
| Falhou em | Quando a entrega falhou. |
| Ações | **Tentar entrega novamente**. |

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

<Steps>
  <Step title="Iniciar a nova tentativa">
    Clique em **Tentar entrega novamente** nas ações da linha.
  </Step>

  <Step title="Confirmar">
    Clique em **Tentar entrega novamente** no diálogo. O endpoint pode receber o evento mais de uma vez.
  </Step>
</Steps>

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

***

<Columns cols={2}>
  <Card title="Webhooks" icon="webhook" horizontal href="/pt/interfaces/ted-jd/ted-webhooks">
    Eventos, verificação de assinatura e o cronograma de novas tentativas.
  </Card>

  <Card title="Guia do desenvolvedor" icon="code" horizontal href="/pt/interfaces/ted-jd/ted-developer-guide">
    Código de validação de assinatura e o checklist de integração.
  </Card>
</Columns>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.