Visão geral
A integração de webhooks permite integrar e enviar eventos e metadados da UserGuiding para qualquer aplicativo de terceiros que ofereça suporte a URLs de webhooks. Você também pode enviar atributos de usuário, atributos da empresa e eventos de usuário desses aplicativos para a UserGuiding.
O que é necessário para ativar a integração de webhooks?
- Você precisa usar um aplicativo de terceiros ou uma plataforma que forneça uma URL de webhook.
- Você precisa criar uma nova URL de webhook no seu aplicativo de terceiros.
Uma URL de webhook funciona como um número de telefone que a UserGuiding pode chamar quando ocorre um evento e falar com o aplicativo receptor.
É mais ou menos assim (lembre-se de que o domínio muda de acordo com o aplicativo):
Ativação da integração de webhooks
Você pode ativar essa integração na aba Integrations, na página Settings.
UserGuiding como Fonte
Os webhooks de saída permitem que você envie dados da UserGuiding para ferramentas externas quando eventos específicos ocorrem. Você pode personalizar quais eventos acionam esses webhooks selecionando Events to Trigger Webhooks.
Rastreamento de Eventos
O UserGuiding envia notificações de eventos em tempo real para Webhooks quando ele está habilitado como origem. Você pode visualizar esses eventos na linha do tempo do contato.
Formato do Evento
Exemplo de Evento
Encontre a lista de todos os eventos que o UserGuiding envia para ferramentas integradas neste artigo.
Testando a integração com Webhook
O UserGuiding envia os dados em formato JSON, e as mensagens de Webhook são enviadas pelo cliente, o que significa que não conseguimos verificar se o processo foi bem-sucedido ou não.
Você pode usar este site para testar a integração. Ao testar, certifique-se de que a opção CORS Headers esteja marcada.
Após concluir a integração, você precisa ativar um material (Guia, Hotspot etc.) e interagir com ele para disparar um evento a ser enviado.
Você também pode verificar se as mensagens HTTP POST estão sendo enviadas para a URL do Webhook que você está usando através da aba Network no console do navegador.
UserGuiding como Destino
- O UserGuiding gera uma URL de Webhook única para sua conta.
- Essa URL inclui um token de autenticação para garantir a transferência segura de dados.
- Quando habilitado, você pode enviar atributos de usuário, atributos de empresa e eventos de usuário de aplicativos de terceiros para o UserGuiding.
- Para integrar com ferramentas externas, você precisa copiar sua URL única de Webhook e colá-la no serviço de terceiros de sua preferência (por exemplo, HubSpot, Marketo, Zapier).
- Observe que adicionar o UserGuiding como destino está disponível para os planos Growth e Enterprise.
Desativando a integração com Webhook
Você pode desativar essa integração desligando as opções dentro da aba Integrations, na página Settings.