API Reference

Integrações

Como discutido no tutorial sobre a adição de blocos ao fluxo, é evidente que o Sendflux oferece uma extensa gama de blocos. Neste artigo, vamos aprofundar nossa compreensão sobre cada tipo de bloco da categoria Integrações disponível, explorando suas características.

Bloco Chat-Center 💬

O Bloco que integra o fluxo do SendFlux com funcionalidades do ChatCenter.

🚧

O mesmo número deve está conectado tanto no SendFlux como no ChatCenter.

Ícone do bloco no menu

Ícone do bloco no menu

Bloco no fluxo

Bloco no fluxo

Conexões ➡️

  • Chamar próximo bloco -> imediatamente aciona o bloco seguinte.

Bloco Web-Hook 🔃

O Bloco dispara eventos configuravéis de Web-Hook visando permitir a comunicação entre o SendFlux e outra aplicação.

Ícone do bloco no menu

Ícone do bloco no menu

Bloco no fluxo

Bloco no fluxo

Conexões ➡️

É possível direcionar para blocos diferentes a depender do Sucesso do disparo ou não como evidenciado na Imagem Bloco no fluxo.

  • Chamar próximo bloco -> imediatamente aciona o bloco seguinte.

Configurando Disparo 👔

Vamos facilitar a configuração do seu evento com o bloco! Basta seguir estes passos simples:

  1. Método: Escolha o método de disparo desejado.
  2. URL: Digite a URL que receberá o evento.
  3. Headers: Se necessário, adicione campos de Headers para personalizar a integração.
  4. Payload: Configure os campos do payload para enviar as informações desejadas.
  5. Salvar: Não se esqueça de clicar em "Salvar" para aplicar suas configurações.

🚧

Para garantir uma integração eficiente e sem contratempos, pode ser necessário configurar campos de headers específicos.

Esses campos podem variar de acordo com a plataforma de terceiros escolhida para a integração. A falta de configuração adequada dos headers pode resultar em falhas na entrega de eventos ou na interpretação incorreta dos dados pela plataforma de destino.

gif exemplificando o processo.

gif exemplificando o processo.

Destrinchando o exemplo 📚

Vamos entender melhor o que acontece neste exemplo! Configuramos um fluxo que armazena a resposta em uma variável chamada {{name}}, utilizando um bloco de texto. Em seguida, com o bloco de WebHook, disparamos um evento, incluindo a variável no payload, no campo name. Abaixo, detalhamos o conteúdo do evento disparado:

{
  "event": "sendflux.com.br",
  "channel": "5599999999999",     //canal conectado ao sendflux
  "chat": "5511111111111",        //número do destinatário
  "vars": {                       // vars faz referência ao campos do payload que usam variavéis
    "name": "Jose Ribeiro"        // nome da variável e valor
  },
  "name": "Jose Ribeiro"          // nome do campo e valor
}

Mensagens pós envio 🔄

Tal bloco permite personalizar a mensagem enviada após o disparo do evento ser bem-sucedido (Sucesso) ou em caso de erro (Erro). Observe que, por padrão, esses campos são automaticamente preenchidos com as variáveis {{response}} e {{error}}, correspondendo ao sucesso e ao erro do evento, respectivamente.

exemplo de configuração de mensagens pós disparo.

exemplo de configuração de mensagens pós disparo.

exemplo do funcionamento em um chat.

exemplo do funcionamento em um chat.

Entendendo o WebHook 🌐

De forma simplificada, o WebHook é como um mensageiro ágil que entrega informações cruciais no exato momento em que acontecem. No contexto do SendFlux, o bloco de WebHook atua como o disparador de eventos com dados personalizáveis assim que é acionado no fluxo, enviando essas informações para a URL especificada. Essa URL pode fazer referência a uma API construída por programadores para ampliar nossas funcionalidades internas ou integrar-se perfeitamente a uma plataforma de terceiros.