Criar e gerenciar assinaturas de webhook do Advocate

Webhooks são código que é executado quando um evento acontece. O Advocate permite que você use webhooks para registrar uma URL para a qual faremos um POST sempre que um evento acontecer no seu programa, por exemplo, quando um código de cupom personalizado é criado para um novo participante, um objeto de evento é criado. Há dois métodos para criar e gerenciar webhooks: pela API do Advocate ou na plataforma do Advocate. Este artigo de ajuda explicará como gerenciar webhooks pela plataforma do Advocate.

Criar uma assinatura de webhook

1. Na barra de navegação superior, selecione [Perfil do usuário] → Configurações.
2. Na coluna da esquerda abaixo de Configurações do Advocate, selecione Webhooks.
3. Na Assinaturas de webhook na página, selecione Criar assinatura.
4. Abaixo de Postar na URL, insira o endereço exclusivo que o aplicativo usa para enviar atualizações em tempo real sobre eventos específicos.
5. Opcionalmente, abaixo de Nome do webhook, insira o nome da nova assinatura de webhook.
6. Selecione Salvar.

Solucionar problemas nos logs de webhook

Quando você registra uma URL para a qual o Advocate faz POST sempre que um evento acontece no seu programa, você pode revisar os logs e solucionar quaisquer eventos de webhook que falharem.

Acessar seus logs de webhook

1. Na barra de navegação superior, selecione [Perfil do usuário] → Configurações.
2. Na coluna da esquerda abaixo de Configurações do Advocate, selecione Webhooks.
3. Na Assinaturas de webhook na página, selecione Ver logs.
4. Use os filtros abaixo Registro de eventos de webhooks para filtrar os webhooks.

   • Consulte a Referência de filtros abaixo para mais informações.

Referência de filtros

Filtro	Descrição
Tipo	Filtre pelo webhook tipo de evento. Este filtro usa como padrão Todos os tipos.
Período	Filtre pelo período em que o webhook foi atualizado pela última vez. Este filtro usa como padrão Todo o período.

Ver detalhes do webhook

1. Selecione um webhook específico para abrir a visualização de Detalhes do webhook visualização.
2. Esta visualização fornece informações que podem ser usadas para solucionar problemas de uma assinatura de webhook.

   • Consulte a Referência do evento abaixo para mais informações.

Referência do evento

Filtro	Descrição
Tipo	O webhook tipo de evento.
ID do webhook	O identificador exclusivo do webhook.
Data de criação	A data em que o webhook foi criado.
Dados do evento	O webhook carga útil.
Assinatura(s)	Assinaturas de webhook para as quais o webhook foi enviado e seus status.
Detalhes da assinatura	Detalhes sobre a resposta recebida do endpoint da assinatura de webhook. Os detalhes podem incluir a tentativa de entrega do webhook, mostrando o carimbo de data/hora da tentativa, o código de status HTTP recebido do destino e se a tentativa expirou devido ao tempo excessivo gasto na solicitação para receber uma resposta do servidor de destino.

Sistema de tentativas de reenvio de webhook para entregas de eventos com falha

• Os webhooks são entregues imediatamente após um evento ser disparado. Se o endpoint não responder com sucesso a uma tentativa de entrega (ou seja, responder com um código de status diferente de 200), a entrega será considerada como falha.
• As entregas com falha serão tentadas novamente a cada hora após a tentativa anterior com falha, até que uma entrega bem-sucedida seja feita ou até que 72 tentativas tenham sido feitas (aproximadamente 3 dias, na taxa de 1 nova tentativa por hora).
• Endpoints de webhook que retornam erros de forma consistente serão desativados automaticamente após o seguinte número de erros:

  Código de status	Erros recebidos
  Erros 4xx	1000
  Erros 5xx	2000
  Erros 3xx	2000