Configurando nós de gatilho de "Integração"

Aprenda a configurar nós de gatilho como "Webhook recebido"

Written By Frieda Yip (Super Administrator)

Updated at August 14th, 2024

Todos os nós de gatilho exigem configuração em um formulário de nó, onde você pode especificar ainda mais os parâmetros para que um fluxo seja acionado. Neste artigo, nós o guiaremos sobre como configurar cada nó de gatilho de “Integração” para que você possa iniciar seus fluxos com base nas circunstâncias esperadas.
 

Webhook recebido

⚠️ O gatilho "Webhook recebido" estará disponível apenas para usuários dos planos Premium e Enterprise

 

O gatilho "Webhook recebido" permite que você inscreva contatos em um fluxo quando o SleekFlow recebe um webhook correspondente às configurações definidas no formulário de nó do gatilho.

Configure o formulário do nó de gatilho "Webhook recebido" seguindo as etapas descritas abaixo:

  1. Ativar nó de gatilho recebido do webhook
  2. Configure seu webhook
  3. Especificar identificador de contato
  4. Configurar persistência de resposta
     

Ativar nó de gatilho “Webhook recebido”

Para ativar o nó de gatilho "Webhook recebido":

  1. Clique no nó para abrir seu formulário, que aparecerá no lado direito da tela
     
  2. Clique no botão “Gerar” dentro do formulário para ativar o nó, gerando as seções necessárias que permitem configurar o gatilho


     
  3. Após clicar em "Gerar", as seguintes novas seções aparecerão no formulário:
    • Configurar
    • Identificar contatos
    • Salvar resposta
       

Os segmentos a seguir deste artigo descrevem o propósito de cada seção e como configurá-las.
 

Configure seu webhook

Após o gatilho "Webhook recebido" ter sido ativado, a primeira seção exibida é "Configuração". Esta seção fornece as informações necessárias para você configurar a conectividade necessária entre seu sistema externo e o SleekFlow, para que seu sistema externo possa enviar um webhook válido para acionar um registro de fluxo.

Você precisará usar os 3 itens a seguir fornecidos na seção "Configuração" para configurar uma conexão webhook adequada do seu sistema externo para o SleekFlow:

  1. URL do Webhook - Esta é a URL para a qual seu sistema externo precisa enviar o webhook para que ele seja recebido pelo SleekFlow
  2. ID do gatilho do webhook - Este ID permite que o sistema SleekFlow mapeie o webhook para o fluxo, garantindo que os contatos sejam registrados corretamente. Forneça isso nos seus cabeçalhos de webhook.
  3. Token de validação - Isso permite que o sistema SleekFlow verifique se o webhook está vindo de você. Forneça isso nos cabeçalhos do seu webhook.


     

Na seção "Configuração", há também um exemplo de código "Postar solicitação" para ajudar você a configurar sua solicitação HTTP para enviar corretamente o webhook ao SleekFlow.


 

As informações fornecidas na seção "Configuração" permitirão que você configure um webhook válido a ser enviado do seu sistema externo para o SleekFlow, acionando as inscrições de fluxo desejadas.
 

Especificar identificador de contato

A seção "Identificar contatos" permite que você configure como o sistema mapeará os webhooks recebidos para os contatos correspondentes inscritos no fluxo.

Esta seção tem 2 campos que você deve preencher:

  1. Contact payload key - Este campo permite que você especifique qual variável dentro do payload do webhook JSON recebido pelo sistema deve ser usada para verificação cruzada com os registros de contato no SleekFlow. Recomendamos usar uma variável que seja um identificador exclusivo para um contato, por exemplo, ID de contato, número de telefone ou e-mail. Use a notação de ponto JSON aqui para especificar qual campo do payload do webhook o sistema deve extrair e referenciar. 

    💡 Explicador de notação de ponto JSON

    A notação de ponto JSON é uma maneira de especificar um campo ou valor particular dentro de uma estrutura de dados aninhada como JSON. Ela permite que você navegue pela estrutura indicando o caminho para o campo desejado usando chaves separadas por ponto.

    Formatar:
    A notação de ponto JSON começa com um $., seguido por todos os nomes de campo listados em ordem sequencial para navegar pela estrutura de dados aninhada para chegar ao seu campo de destino. Cada nome de campo especificado na notação é separado por um ponto (por exemplo, $.key1.key2.key3)

    Exemplo:
    Para a carga útil especificada abaixo, o campo de número de telefone seria representado usando a notação de ponto JSON como esta: $.data.profile.phone
    {
    "dados": {
    "id": "12345",
    "nome": "Bob Chan",
    "perfil": {
    "e-mail": "bob@ sleekflow .io",
    "telefone": "85298007899"
    }
    }

     

     
  2. Tipo de identificador - Este menu suspenso permite que você selecione qual propriedade de contato o sistema irá cruzar seu identificador de contato especificado com os registros de contato da sua conta SleekFlow. Selecione entre 3 opções:
    • ID de contato (ou seja, o UUID exclusivo de cada contato fornecido pelo SleekFlow)
    • Número de telefone
    • E-mail 

      💡 Nota sobre contatos inexistentes

      Pode haver casos em que o identificador de contato fornecido na carga útil do webhook JSON não corresponde a um contato existente na sua conta do SleekFlow.

      Quando "Número de telefone" ou "E-mail" é selecionado como seu "Tipo de identificador", uma opção adicional - "Inscrição de novo cliente" - é fornecida para lidar com esses casos.



      Se "New customer registration" estiver ativado, um número de telefone ou endereço de e-mail fornecido no payload do webhook que não pode ser correspondido com um contato existente no SleekFlow terá automaticamente um novo registro de contato criado com o identificador de contato fornecido. O contato recém-criado será então inscrito no fluxo.

       

 

Configurar persistência de resposta

A seção "Salvar resposta" permite que você especifique pontos de dados dentro do payload do webhook JSON recebido para salvar e usar mais tarde como uma variável no fluxo. Isso lhe dará mais flexibilidade na criação de interações personalizadas com seus contatos por meio de dados dinâmicos.



Esta seção permite que você adicione pares de chave-valor para valores dentro do webhook que você deseja salvar como uma variável, bem como fornecer nomes de variáveis para salvá-los. Cada par de chave-valor consiste nos 2 campos a seguir:

  • {{variable}} - Especifique o nome da variável que o sistema usará para armazenar os dados extraídos do payload do webhook. Você pode usar essa variável em nós de condição e ação subsequentes dentro do fluxo quando quiser referenciar os valores extraídos do payload do webhook. Especifique o nome da variável desejada neste campo usando chaves duplas (por exemplo , {{variable_name}} )
  • $.response_variable - Este campo permite que você especifique a variável para extrair valores de dentro do payload do webhook JSON recebido pelo sistema. Use a notação de ponto JSON aqui para especificar qual campo do payload do webhook o sistema deve extrair (consulte o explicador de notação de ponto JSON ).