Webhook

No menu “Configuração”, há a opção Webhook. Nesta funcionalidade, você poderá receber comunicação em tempo real das interações de suas comunicações para acompanhar a efetividade de suas jornadas.
Nesta opção é possível:
Criar um novo Webhook;
Editar ou testar um Webhook criado.
Criação de Endpoint
Dentro do menu Webhook, clique em “+Novo Webhook”.
A partir daí, será necessário preencher algumas informações em cada uma das telas.
​
Cadastro
Nesta tela, preencha um nome para o Endpoint, a URL do Webhook, uma pequena descrição com até 160 caracteres e escolha o Content Type, que é o tipo do arquivo que será enviado.
Para segurança no envio da informação, é importante que a URL indicada seja pública e que responda a requisições HTTP/HTTPS não autenticadas. Também é importante que a URL não esteja num contexto de VPN.
Após preenchimento dos dados, clique em “Próximo” para seguir. 
Notificação
Na etapa de Notificação, é necessário preencher um e-mail válido para recebimento de notificações sempre que houver alterações ou erros. Depois, é só clicar em “Próximo”. 
Canais
A terceira etapa é a de Canais. Nela, você escolhe qual canal será considerado no seu webhook. É possível escolher a opção de todos os canais ou combinações de quais canais quiser. Após a seleção, clique em “Próximo”. 
Eventos
A quarta etapa é a de Eventos. Nesta tela, você pode selecionar todas as jornadas ativas ou optar por escolher algumas específicas. Para escolher as jornadas, basta utilizar o combo onde são apresentadas todas as disponíveis ou realizar a busca no campo de busca.
Após a seleção de uma jornada, abrirão as mensagens vinculadas a ela e ao canal já escolhido anteriormente. Em cada mensagem, será possível selecionar as interações. É possível escolher todas ou fazer combinações das interações utilizadas.
É possível adicionar mais de uma jornada em seu webhook. Abaixo das interações, você encontra um novo combo para poder selecionar outra jornada.
Após o término da seleção, clique em “Ativar” para seguir.
Teste
A última etapa é a de Teste. Por ser bastante importante, é possível testar o webhook a qualquer momento. Porém, isto só poderá ser feito quando o endpoint já estiver ativo.
Clique em “Testar” para saber se o webhook está funcionando corretamente. 
Ao final, clique em “Finalizar”. A partir daí, seu webhook já está criado, basta aguardar recebimento.
O envio ao endpoint ocorre no momento que os eventos são processados pela plataforma. O serviço tenta enviar os eventos ao endpoint durante um período de 7 dias após a primeira tentativa de envio. O intervalo entre as tentativas de envio é incrementado a cada falha, seguindo a tabela abaixo.
Número de Tentativas
Intervalo
1
Imediato
2
1h 
3
2h
4
3h
5
5h
6 
8h
6 >
Reinicio do intervalo              
Após o período de 7 dias, o envio não mais ocorrerá e os dados “perdidos” podem ser solicitados através do atendimento.  Os dados serão gerados em uma arquivo no formato CSV e o tempo de geração dependerá do volume em questão.

O retorno dos dados trará diversos campos com as informações solicitadas. É importante compreender o que significa cada um destes campos para melhor entendimento dos dados. Abaixo, segue tabela com os campos, descrições e informações adicionais, quando necessárias.
​
Nome do campo
Descrição
Informações Adicionais
created
É a data/hora que o evento foi processado pela plataforma
Formato ISO8601
tenantId
Identificador do tenant
​
tenantName
Nome do tenant
​
journeyId
Identificador da jornada
​
journeyVersion
Identificador da versão da jornada
​
journeyName
Nome da jornada
​
nodeKey
Identificador do canal
​
nodeName
Nome do canal
​
channelKind
Tipo do canal
​
shootingId
Identificador do disparo
​
shootingCreated
Data/Hora que o disparo ocorreu na plataforma
​
shootingCorrelationId
Identificador único do disparo.
Essa informação é fornecida durante o envio pela API do Jornada.  Deve ser utilizada pelo cliente para identificar o disparo dentro de sua plataforma
tTrackingUrl
Caso seja um evento de clique aqui será apresentada o link clicado
Apenas para Email, SMS e WhatsApp
trackingIp
Número do IP onde o evento ocorreu.  Pode ocorrer para eventos de clique e abertura de e-mail.
Apenas para Email, SMS e WhatsApp
userAgent
Perfil de navegação utilizado para abrir o email
Apenas para Email, SMS e WhatsApp.
Para mais informações no Wikipedia​
userAgentBrowserFamily
Texto que identifica o navegador onde o evento ocorreu
​
userAgentBrowserVersion
Texto que identifica a versão do navegador onde o evento ocorreu
​
userAgentOSFamily
Texto que identifica o sistema operacional onde o evento ocorreu
​
userAgentOSVersion
Texto que identifica a versão do sistema operacional onde o evento ocorreu
​
Para cada cliente, o relatório irá retornar o tipo de evento realizado em cada um dos canais em que houve interação.
Em cada canal é possível identificar os seguintes eventos:
​
Mail
SMS
Print
WhatsApp
Processed
Processed
Processed
Processed
Dropped
Dropped
Posted
Read
Delivered
Delivered
PrintReleased
​
Deferred
Bounce
Printed
​
Bounce
SentToProvider
PrintRestarted
​
Open
Reply
​
​
Click
Click
​
​
SpamReport
​
​
​
Optout
​
​
​
Para melhor compreensão dos eventos, segue tabela com a descrição de cada um deles:
​
Eventos
Descrição
Processed
Enviado
Dropped
Enviado, porém não entregue por erro
Delivered
Recebido
Click
Algum link dentro da mensagem foi clicado
Bounce
Não entregue
Deferred
Entrega adiada temporariamente
Open
Aberto pelo destinatário
SpamReport
Denúncia de que mensagem enviada tratava-se de spam
Opt-out
Destinatário optou por se descadastrar da lista de recebimento
SentToProvider
Enviado ao provedor
Reply
Respondido
Read
Mensagem lida pelo destinatário
Processed
Processado
PrintReleased
Pronto para impressão
Printed
Impresso
PrintRestarted
Impressão reiniciada
Edição de Endpoint
Dentro do menu Webhook, você terá acesso a lista de todos os webhooks criados. 
Caso deseje editar alguma informação, clique no nome do Webhook para abrir suas informações.
​
Você poderá alterar todos os campos da tela de Cadastro, mas é fundamental que todos os campos estejam preenchidos.
É possível também alterar o e-mail preenchido na tela Notificações.
Já na etapa Canal, não é possível fazer nenhuma edição. Para essa alteração, indicamos criar um novo Webhook.
Na etapa Eventos, é possível fazer novas seleções de jornadas e interações.
Por fim, a etapa de Teste, que pode ser executada a qualquer momento.
Não se esqueça de clicar em “Salvar”, na parte inferior da tela de cada etapa, para garantir uma edição com sucesso.
Dados do Cliente
Lista de Contatos
Last modified 5mo ago
Copy link
Contents