Guia rápido de início de Webhooks

Webhooks permitem que você poste informações ou acione ações fora do seu app ou site. Você pode usar webhooks para fornecer informações em tempo real a outros sistemas e aplicações. Por exemplo, enviar informações para um DMP ou CDP, colocar uma tarefa em um CRM ou acionar uma ação em outro sistema. A flexibilidade desse canal permite que você envie informações para qualquer endpoint.

Ativando o canal do webhook

Para ativar o canal Webhook, navegue até Configurações > Canais > Gerenciar Canais e ative a opção de alternar Webhook .

Depois de ativado, você o verá como um canal de comunicação no menu de criação de campanhas (Campanhas > Criar Campanha > Etapa única > Baseado em tempo > Criar Campanha > selecione Webhook na aba Configuração).

Navegue até a aba Conteúdo para construir seu webhook.

Monte um webhook

Para usar um webhook, você precisará ter documentação de API para o serviço para o qual deseja enviar informações ou realizar uma ação. Você pode construir e testar isso em uma campanha. O canal webhook tem provisão para todos os principais componentes que você precisará para construir uma chamada API para outro sistema. Confira nosso guia de conteúdo de webhooks para mais detalhes sobre como configurar seu webhook.

Teste um webhook

É recomendável testar webhooks antes de implantá-los para sua base de usuários. Para testar um webhook, crie sua campanha do jeito que normalmente faria e mire usuários de teste.

Webhooks dependem dos servidores do Xtremepush fazendo requisições para um endpoint externo, e erros de sintaxe e outros podem surgir. O primeiro passo para evitar erros de webhook é testar sua campanha de webhook para erros de sintaxe e garantir que variáveis personalizadas tenham um valor de backup. No entanto, webhooks ainda podem falhar devido a problemas como chaves de API expiradas, limites de taxa ou erros inesperados do servidor. Se seu webhook falhar, uma mensagem de erro é registrada no registro de notificações, acessível a partir de Campanhas > Campanhas Existentes > menu Opções:fa-ellipsis-v: à direita do registro de campanhas > Notificações. Para mais informações, consulte nosso guia dedicado de registro de notificações .

Se você estiver trabalhando com um terceiro e cometeu um erro na URL, o registro de notificações mostrará que a campanha do webhook falhou em enviar:

Clicando no menu Opções:fa-ellipsis-v: > Detalhes , é possível aprofundar os detalhes do erro:

Se o corpo da mensagem não estiver claro o suficiente quanto à origem do erro, você deve verificar a documentação do endpoint da API que está usando. Esses geralmente fornecem uma explicação dos códigos de erro que o endpoint utiliza, bem como do que normalmente são causados.