Jornadas
Search…
Serviço: Webhook de Eventos
Esse serviço é responsável por enviar a um determinado endpoint todos os eventos que ocorreram nas comunicações enviadas pela plataforma.

Segurança

O endpoint deve ser uma URL pública que responda a requisições HTTP/HTTPS não autenticadas. Também é importante que a URL não esteja num contexto de VPN.
Para ativar esse serviço, é necessário uma solicitação formal à Central de Suporte

Envios ao Endpoint

O envio ocorre no momento que os eventos são processados pela plataforma. Trata-se de uma requisição HTTP/HTTPS utilizando o método POST. O conteúdo pode ser um JSON ou XML contendo um ou mais eventos.
O serviço tenta enviar os eventos durante um período de sete 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 sete dias o envio não ocorrerá mais e os dados “perdidos” podem ser solicitados através do atendimento. Os dados serão gerados em um arquivo no formato CSV e o tempo de geração dependerá do volume em questão.

Tipos de Canais

É possível receber status dos envios de comunicações via webhook pelos seguintes canais:
  • E-mail
  • SMS
  • WhatsApp
  • Print (impresso)

Tipos de Eventos

Evento
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

Eventos por Canais

Cada canal contém eventos específicos:
Eventos
E-mail
SMS
Print
WhatsApp
Processed
🟢
🟢
🟢
🟢
Dropped
🟢
🟢
Delivered
🟢
🟢
Click
🟢
🟢
Bounce
🟢
🟢
Deferred
🟢
Open
🟢
SpamReport
🟢
Opt-out
🟢
SentToProvider
🟢
Reply
🟢
Read
🟢
Posted
🟢
PrintReleased
🟢
Printed
🟢
PrintRestarted
🟢

Descrição dos campos

Nome do campo
Descrição
Informações Adicionais
created
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á apresentado o link clicado
Apenas para E-mail, 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 E-mail, SMS e WhatsApp
userAgent
Perfil de navegação utilizado para abrir o e-mail
Apenas para E-mail, SMS e WhatsApp.
Para mais informações, veja a 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

Exemplo de retorno em JSON

1
{
2
"Created": "2021-03-05T17:43:38Z",
3
"TenantId": "5524151a19a226aab39c24e3",
4
"TenantName": "directone",
5
"JourneyId": "6016ba9f5541248321e2bec1",
6
"JourneyVersion": "6016baad5541248321e2bec2", //Versao da Jornada
7
"JourneyName": "Teste sexta a tarde",
8
"NodeKey": "fccf80c0-640a-11eb-8810-953322941307",
9
"NodeName": "Greetings",
10
"ChannelKind": "Sms",
11
"ShootingId": "60426d935246316a5a4eab90",
12
"ShootingCreated": "2021-03-05T17:42:43.036Z",
13
"ShootingCorrelationId": "d9c5cf30-84e7-4ffa-915c-465384f1801a",
14
"TrackingUrl": "",
15
"TrackingIp": "",
16
"UserAgent": "",
17
"UserAgentBrowserFamily": "",
18
"UserAgentBrowserVersion": "",
19
"UserAgentOSFamily": "",
20
"UserAgentOSVersion": "",
21
"UserAgentDeviceFamily": "",
22
"CarrierName": "",
23
"Recipient": "[email protected]",
24
"EventType": "Processed",
25
"BounceType": "",
26
"BounceReason": "",
27
"Response": "",
28
"EventDate": "2021-03-05T17:43:38Z",
29
"MovementDate": "2021-03-01T03:00:00Z",
30
"MovementFilename": "",
31
"MovementLot": "",
32
"IntegrationId": "74A5D2C9E95AD17DBBA75D59858443D3A418712358E1C9CFC62103980A5BEF89",
33
"IntegrationCreated": "2021-03-05T03:00:00Z",
34
"IntegrationProcessingDate": "2021-03-05T03:00:00Z",
35
"CustomerId": "1234",
36
"CustomerIdentification": "1234",
37
"CustomerName": "Johnny Guielebo",
38
"DocumentDescription": "Fatura",
39
"DocumentDueDate": "2021-03-15T03:00:00Z"
40
}
Copied!