Configurar webhooks

Configure webhooks no Logto Console para alcançar integração perfeita e receber notificações de eventos em tempo real para o seu aplicativo. Desfrute de configuração fácil, segurança aprimorada e opções convenientes de monitoramento de saúde.

Criar um webhook

Primeiramente, crie um endpoint de webhook que será chamado pelo Logto Agent. Este endpoint deve ser implementado no seu servidor e capaz de receber solicitações HTTP.

Para criar um novo webhook no Logto Console, siga estas etapas:

1. Criar webhook: Navegue até Console > Webhooks e clique no botão "Criar webhook".

2. Nome: Forneça um nome para o webhook. É para sua própria referência para definir o cenário de uso.

3. Endpoint URL: Insira o Endpoint URL, que é o URL do seu servidor que receberá as solicitações POST do webhook quando o evento ocorrer. Por razões de segurança, o URL deve ser publicamente acessível via HTTPS e não deve ser um URL de host local.

   nota

   Seu servidor deve responder às solicitações de webhook do Logto com uma resposta HTTP 200 ("OK") logo após receber a solicitação para notificar que a solicitação foi recebida.

   Aguardar a conclusão do processamento da lógica do evento correspondente do Webhook antes de responder pode causar o tempo limite do Webhook.

   Não retorne nenhuma resposta diferente de 200 para o webhook do Logto. Se ocorrer um erro ao processar o evento, lide com ele no seu próprio servidor.

4. Evento: No modal que aparece, selecione os eventos desejados que acionarão este webhook. Recomenda-se escolher um número menor de eventos que atendam aos seus requisitos para evitar sobrecarregar a recepção do servidor. Você pode alterar os eventos selecionados a qualquer momento após criar o webhook.

   

5. Desativar / Reativar: Por padrão, o webhook é ativado imediatamente após a criação. Se você quiser suspender o webhook temporariamente, pode desativá-lo ou reativá-lo usando o menu "Três Pontos" localizado no canto superior direito do cabeçalho após criá-lo.

Proteger webhook

Uma vez que seu servidor esteja pronto para receber solicitações de webhook, você pode querer garantir que ele possa lidar com as solicitações de forma segura. O Logto gera uma assinatura para cada payload de solicitação de webhook, o que permite verificar se a solicitação vem do Logto.

Após criar um novo webhook, você tem opções para aumentar sua segurança:

• Chave de assinatura: O Logto gera uma assinatura hash única, conhecida como Chave de Assinatura, para cada webhook. Você pode incluir essa chave como um cabeçalho de solicitação na implementação do seu endpoint. Verificar a chave de assinatura garante que o payload do webhook se origina do Logto e não foi adulterado por fontes não autorizadas. Leia protegendo seus webhooks para saber mais sobre o código.
• Cabeçalho personalizado: Você tem a opção de incluir cabeçalhos personalizados no payload do webhook para fornecer contexto ou metadados adicionais. Este recurso permite adicionar informações relevantes que podem ajudar a processar os dados do webhook de forma eficaz.

Utilizando a Chave de Assinatura e considerando a inclusão de Cabeçalhos Personalizados, você pode aumentar a segurança dos seus webhooks e garantir a integridade e autenticidade dos payloads recebidos.

Testar webhook

Para testar a conexão entre o Logto e seus serviços, basta clicar no botão "Enviar payload de teste". O Logto enviará então um payload de exemplo para cada evento selecionado para o seu Endpoint URL. Essas solicitações de teste contêm dados anônimos e não são registradas no histórico de solicitações recentes.

Este teste garante que seu webhook esteja configurado corretamente para receber e processar payloads do Logto. Ele permite validar a integração antes de implantar o webhook em um ambiente ao vivo.

Monitorar status de saúde do Webhook

O Logto fornece ferramentas convenientes para monitorar o status de saúde dos seus webhooks e investigar quaisquer problemas potenciais em detalhes:

• Status de saúde A lista de webhooks no Logto exibe o status de saúde de cada webhook, incluindo a taxa de sucesso e o número total de solicitações feitas nas últimas 24 horas. Esta informação oferece uma visão geral do desempenho do webhook.
• Logs de solicitações independentes Na seção "Solicitações Recentes" de cada webhook, você pode acessar os logs de solicitações das últimas 24 horas. Cada solicitação é registrada individualmente, permitindo que você visualize os detalhes de cada solicitação e investigue quaisquer erros ou anomalias potenciais.
• Repetição automática No caso de uma entrega falhada (quando o status da resposta do webhook é maior ou igual a 500), o Logto tenta automaticamente a entrega novamente até três vezes. Fique tranquilo, pois múltiplas tentativas da mesma solicitação gerarão apenas uma única entrada de log, evitando duplicações desnecessárias.

Aproveitando esses recursos de monitoramento, você pode acompanhar efetivamente a saúde dos seus webhooks, examinar logs de solicitações e garantir a confiabilidade e o desempenho das suas integrações de webhook.