WebHook

Neste artigo você vai encontrar:

Quais os dados serão enviados;
O passo a passo para integração;
O Vínculo do tipo de envio envio com a integração:
- Campanha;
- Interação;
- Botão;

1. O envio dos dados

Os dados serão enviados no formato JSON através de uma requisição HTTP, utilizando o método POST. Os dados enviados são os seguintes:

Descrição do objeto enviado pelo Web Hook (JSON)

{
    access: Dados do Acesso
    {
        accessId: ID do acesso, 
        accessDate: Data do acesso yyyy-MM-dd HH:mm:ss
    }, 
    establishment: Dados do Estabelecimento
        {
            establishmentName: Nome do estabelecimento responsável pelo acesso, 
            localName: Nome do local onde foi realizado o acesso, 
            accessPointName: Nome do ponto de acesso onde o cliente se conectou, 
            district: Bairro onde foi realizado o acesso, 
            city: Cidade onde foi realizado o acesso, 
            state: Estado onde foi realizado o acesso, 
            country: País onde foi realizado o acesso
        }, 
    campaign: Dados da Campanha
        {
            campaignId: ID da campanha, 
            campaignName: Nome da campanha
        }, 
    client: Dados do Cliente
        {
            clientId: ID do cliente, 
            clientName: Nome completo do cliente, 
            clientEmail: Endeço de e-mail do cliente, 
            clientBirthDate: Data de nascimento do cliente, 
            clientGender: Sexo do cliente (MASCULINO, FEMINO, NAO_DECLARADO), 
            clientPhone: Número do telefone do cliente
        }, 
    interactions: Dados das interações respondidas no momento do acesso
    [
        {
            interactionId: ID da interação, 
            interactionName: Nome da interação, 
            interactionDescription: Descrição da Interação, 
            interactionType: Tipo da Interação (BANNER, PESQUISA_OBJETIVA, PEQUISA_NPS, CODIGO_PROMOCIONAL), 
            selectedOption: Opção selecionada (ID da opção), 
            descriptionSelectedOption: Descrição da opção selecionada
        }
    ],
    clientExtraFields: Campos extras do cliente como CEP ou CPF (formato String Array JSON)
}

Exemplo do Request Body:

{
    access:
    {
        accessId: 0, 
        accessDate: 2022-09-28 21:00:27
    }, 
    establishment:
        {
            establishmentName: “Estabelecimento de Teste”, 
            localName: “Local de Teste”, 
            accessPointName: “Aparelho de Teste”, 
            district: “Centro”, 
            city: ”Florianópolis”, 
            state: “SC”, 
            country: “Brasil”
        }, 
    campaign:
        {
            campaignId: 0, 
            campaignName: “Campanha de Teste”
        }, 
    client:
        {
            clientId: 0, 
            clientName: ”WiFeed Teste”, 
            clientEmail: ”[email protected]”, 
            clientBirthDate: “22-04-2000”, 
            clientGender: “NAO_DECLARADO”, 
            clientPhone: “48955555555”
        }, 
    interactions:
    [
        {
            interactionId: 0, 
            interactionName: “Interação de Teste”, 
            interactionDescription: “Descrição da Interação”, 
            interactionType: “Banner”, 
            selectedOption: 0, 
            descriptionSelectedOption: “Botão Primário”
        }
    ],
    clientExtraFields: “[
          {
                cpf: \”401.413.940-99\”
          },
          {
                cep: \”88154-568\”
          }
    ]”
}

2.Integração do WebHook

Localize o menu de configurações à esquerda;
Clique em Configurações e em seguida Integrações;
Clique em Criar Integração;
Inserir o Nome da Integração;
Selecionar o Tipo de Integração: WebHook;
Autorizar a API;

URL: O endereço para onde serão enviados os dados do acesso quando o cliente responder uma interação de campanha;

Chave para Header de requisição: Para aumentar a segurança, é possível definir um header que será enviado na requisição, este campo define o nome desse header;

Valor para Header da requisição: É o valor que será atributo ao header informado no campo anterior;

Email de aviso: Caso ocorra algum problema no envio das requisições, este email será informado.
Clique em Salvar;

3.Vincular Webhook na Campanha

Para que o sistema realize o envio das informações de acesso via Web Hook, é necessário vincular o registro do Web Hook com uma campanha, interação ou opção de interação.

Campanha

No vínculo de campanha, cada vez que o cliente responder uma interação, serão enviados os dados de acesso para o Web Hook. Então se o cliente passar por 3 interações, serão feitos 3 envios de dados para o Web Hook.

Para configurar esse vínculo, na tela de criação de campanha, clique no botão Configurações avançadas;
Habilite a opção Vincular integração e selecione o registro de integração criado anteriormente;
Clique em salvar;

Interação

No vínculo de interação, os dados serão enviados para o Web Hook quando o cliente

selecionar qualquer uma das opções da interação.

Para configurar o vínculo, entre em campanhas;
Na tela de edição de interações, selecione a interação que deseja vincular o Web Hook
Localize no painel de configurações que aparece à direita da tela
Habilite a opção Habilitar integração, posteriormente, selecione o registro de integração criado anteriormente.
Pronto, o sistema salvou automaticamente sua alteração;

Opção (Botão)

No vínculo de opção, os dados só serão enviados ao Web Hook caso o cliente tenha selecionado a opção onde o Web Hook foi vinculado.

Para criar o vínculo, entre em campanhas;
Na tela na tela de edição de interações, no painel de configurações que aparece à direita da tela ao selecionar uma interação localize o botão;
Clique no ícone de Configuração que aparece ao lado de cada opção existente na interação.
Habilite a opção Vincular integração e selecione o registro de integração criado anteriormente.