Os nós de gatilho de Webhook permitem que sistemas externos se comuniquem com a SleekFlow enviando dados para iniciar fluxos. Ao usar gatilhos relacionados a webhooks, você pode inscrever contatos automaticamente em um fluxo quando a SleekFlow recebe uma solicitação de webhook que corresponde à configuração definida.
ℹ️ Saiba mais sobre gatilhos de fluxo neste artigo: Visão geral dos gatilhos de fluxo
Esse recurso é especialmente útil para integrações com plataformas de terceiros, sistemas internos ou ferramentas personalizadas que precisam acionar fluxos de trabalho na SleekFlow em tempo real.
Payload de webhook recebido
⚠️ O gatilho “Payload de webhook recebido” está disponível apenas para usuários dos planos Premium e Enterprise.
O gatilho “Payload de webhook recebido” permite inscrever contatos em um fluxo quando a SleekFlow recebe um webhook de entrada que corresponde às configurações definidas no formulário do nó.
Para configurar o nó de gatilho “Payload de webhook recebido”, siga as etapas abaixo:
- Selecione o nó de gatilho Payload de webhook recebido
- Configure o webhook
- Defina o identificador do cliente
Configurar o nó de gatilho “Payload de webhook recebido”
- Clique no nó de gatilho Payload de webhook recebido para abrir o formulário do nó, que aparecerá no lado direito da tela.
- O formulário do nó contém os seguintes campos para configurar o gatilho
-
Configuração
Esta seção fornece todas as informações necessárias para conectar seu sistema externo à SleekFlow. Quando configurada corretamente, ela permite que a SleekFlow receba uma solicitação de webhook e inscreva o contato correspondente no fluxo.- URL do webhook: URL para a qual o sistema externo deve enviar o webhook para que ele seja recebido pela SleekFlow.
- ID do gatilho de webhook: esse ID permite que o sistema da SleekFlow associe o webhook ao fluxo correto, garantindo que os contatos sejam inscritos adequadamente. Inclua esse ID no header do webhook.
- Token do webhook: permite que o sistema da SleekFlow verifique se o webhook foi enviado por você. Inclua esse token no header do webhook.
-
Exemplo de requisição POST do webhook: um exemplo preenchido automaticamente é fornecido para referência ou testes durante a implementação.
Definir o identificador do cliente
Na seção “Informações de configuração”, você também encontrará a área “Identificador do cliente”. Essa seção permite configurar como o sistema associará os webhooks recebidos aos contatos correspondentes que serão inscritos no fluxo.
Essa seção contém 2 campos obrigatórios:
- Tipo de identificador: Esse menu suspenso permite selecionar qual propriedade de contato o sistema usará para comparar o identificador fornecido no webhook com os registros de contato da sua conta da SleekFlow. Escolha uma das opções:
- ID do contato (ou seja, o UUID exclusivo de cada contato fornecido pela SleekFlow)
- Número de telefone
💡Observação sobre contatos inexistentes:
Pode haver casos em que o identificador fornecido no payload JSON do webhook não corresponda a um contato existente na sua conta da SleekFlow.
Quando “Número de telefone” ou “E-mail” é selecionado como Tipo de identificador, um botão adicional — “Inscrição de novo cliente” — fica disponível para lidar com esses casos.
Se “Inscrição de novo cliente” estiver ativado, um número de telefone ou e-mail fornecido no payload do webhook que não corresponda a nenhum contato existente terá automaticamente um novo contato criado com esse identificador. O contato recém-criado será então inscrito no fluxo.
- Chave do payload do contato: Esse campo permite especificar qual variável dentro do payload JSON recebido pelo webhook deve ser usada para comparação com os registros de contato na SleekFlow. Recomendamos usar uma variável que seja um identificador exclusivo do contato, como ID do contato, número de telefone ou e-mail. Utilize a notação de ponto JSON para indicar qual campo do payload deve ser extraído e referenciado.
💡Explicação da notação de ponto JSON
A notação de ponto JSON é uma forma de especificar um campo ou valor específico dentro de uma estrutura de dados aninhada, como um objeto JSON. Ela permite navegar pela estrutura indicando o caminho até o campo desejado por meio de chaves separadas por ponto.
Formato
A notação começa com $., seguida pelos nomes dos campos em ordem sequencial, separados por ponto. Exemplo: $.chave1.chave2.chave3
Exemplo prático
Para o payload abaixo, o campo de número de telefone pode ser representado da seguinte forma: $.data.profile.phone
{
"data": {
"id": "12345",
"name": "Bob Chan",
"profile": {
"email": "bob@sleekflow.io",
"phone": "85298007899"
}
}
Colar payload de resposta de exemplo
Após configurar o webhook e definir o identificador do contato, você pode acessar a aba “Variável”. Nessa aba, você define como a SleekFlow deve interpretar e extrair dados do payload de webhook recebido. Ela permite visualizar e configurar as variáveis que poderão ser usadas ao longo do fluxo.
Passo a passo:
- Cole um payload JSON de exemplo
Copie um payload representativo de solicitação de webhook do seu sistema externo e cole-o no campo disponível. Esse JSON deve refletir a estrutura e o conteúdo reais que serão enviados quando o webhook for acionado.
⚠️ Os dados colados aqui são usados apenas para análise e extração de variáveis e não serão armazenados na SleekFlow após o processamento.
- Clique em “Analisar dados”
Após colar o JSON, clique no botão Analisar dados. A SleekFlow extrairá automaticamente todos os campos de nível superior e aninhados, convertendo-os em variáveis utilizáveis.
- Use as variáveis extraídas
Após a análise, essas variáveis poderão ser usadas em todo o fluxo — incluindo templates de mensagens, ramificações condicionais ou qualquer outro nó que ofereça suporte a variáveis dinâmicas.