Jornadas
Search…
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.