O que é Webhook?
O Webhook é uma tecnologia utilizada para permitir a comunicação entre dois sistemas enviando notificações quando algum tipo de evento acontece na plataforma de origem dos dados.
Basicamente, o Webhook é um sistema de notificações que envia informações para outras plataformas interessadas.
Na Track CXM, ao utilizar o Webhook as notificações e dados serão enviados sempre que uma nova interação completa chegar na sua conta.
Importante:
O webhook gera apenas notificações de interações completas.
Quais informações enviamos por Webhook?
As informações enviadas são:
-
Tipo de evento (Atualmente enviamos apenas informações de respostas de pesquisa)
-
Identificador da interação
-
Identificador da distribuição
-
Identificador da pesquisa
-
Nome da pesquisa
-
Public Hash da pesquisa
-
Data de resposta da pesquisa
-
Data da distribuição da pesquisa
-
Canal de resposta da pesquisa
-
Saúde da interação
-
Tipo das perguntas
-
Respostas das perguntas
-
Comentários das perguntas
-
Dados do cliente (Atributos do cliente)
-
Dados da interação (Atributos da interação)
Essas informações são enviadas em um objeto JSON no seguinte formato:
{
"events": [
{
"type": "answer",
"interaction_uuid": "d2f8c31e-81ae-449e-7e00-011fa1c8ff3c", // uuid v4
"distribution_uuid": "530c7076-68e1-4f91-4b1f-a61730a6cbf6", // uuid v4
"survey_uuid": "d10072c6-0900-40d7-5a68-bf4df2282572", // uuid v4
"survey_name": "Survey Test Webhook", // string
"survey_public_hash": "HXKZ", // string
"answered_at": 1616611853, // unix timestamp (integer)
"distributed_at": 1616611843, // unix timestamp (integer)
"answered_channel": "web", // web, widget, sms
"distribution_channel": "email", // e-mail, sms, widget, link, lista de links, qrcode
"health_score": 96, // integer
"answers": [
{
"item_uuid": "49725fe0-31af-46c2-8d61-27980d880541" // uuid v4
"question_type": "nps_relational", // nps_relational, nps_transactional, ces, ces2, csat, ratings, emoji, thumbs, multiple_choice, open
"question": "..." // string
"answer": "...", // string de inteiro ou array de strings para respostas de perguntas do tipo múltipla escolha. Ex .: {"Resposta A","Resposta B"])
"comment": "...", // string
"other_option": "...", // string (outra opção para múltipla escolha)
},
...
],
"customer": {
"name": "...", // string
"email": "test@test.com", // email string
"phone": "5531999999999", // integer
"attributes": [
{
"uuid": "a4b51e42-7bc3-46da-570e-b2112174475d", // uuid v4
"name": "cpf", // string
"value": "121.744.530-71" // string
}
]
},
"interaction_attributes": [
{
"uuid": "018c415b-0c78-4085-516e-4bb498b722a3", // string
"name": "productid", // string
"value": "2" // string
}
]
}
]
}
Como usar o Webhook da Track CXM?
Para utilizar o Webhook da Track CXM acesse o menu de Configurações, sessão "Avançado" >> Integrações, clique em “Configuração” do bloco "Webhook" e o ative:
Após ativar o Webhook, adicione a URL que você deseja direcionar as notificações e use o token que será disponibilizado para que o serviço de leitura da notificação tenha autorização para fazê-la.
Após adicionar a URL e copiar seu Token, clique em salvar:
O token informado é utilizado no cabeçalho (header) 'Authorization' da solicitação no seu sistema de leitura de notificações.
Exemplo:
Authorization: Bearer
Uma vez que suas informações forem salvas, utilize os dados fornecidos para finalizar as integrações no seu serviço de recebimento de Webhooks e pronto, seu Webhook estará ativado!
Existem sites para teste de Webhook como o Webhook.site, que fornece uma URL que pode receber os testes da sua conta!
Qualquer dúvida, conte conosco! A equipe de Atendimento ao Cliente está aqui para você. Utilize o chat na parte inferior direita da tela para nos acionar.
Sinta-se à vontade para enviar suas dúvidas também por e-mail para suporte@track.co, ou nos ligar diretamente no telefone: (11) 4858-9924, digitando a opção 5.