Skip to main content

​
Como funciona

A condição Fluxo disparado externamente da IDR gera uma URL de webhook. Quando o seu sistema envia uma requisição para essa URL, o Invenio identifica o contato (ou cria um novo, se ele não existir) e executa as ações configuradas no fluxo para ele.
Esta página trata da origem Invenio API, em que o seu próprio sistema monta e envia o payload. As demais origens da condição (RD Station, Shopify, Monetizze, WooCommerce, Eduzz, Hotmart, Stripe, ActiveCampaign, Nuvemshop e Mercado Pago) recebem o payload no formato de cada plataforma e não seguem este documento.

​
Configuração na IDR

1

Adicione a condição

No editor da IDR, adicione uma condição do tipo Fluxo disparado externamente e selecione a origem Invenio API.
2

Copie a URL do webhook

O campo Webhook mostra a URL que o seu sistema deve chamar, no formato:
3

Mapeie os campos do contato

Informe em que caminho do JSON enviado estão os dados do contato. O caminho é livre e usa ponto para objetos aninhados:Se o seu sistema envia os dados em outro formato, ajuste o caminho. Por exemplo, PhoneNumber para um telefone na raiz do JSON, ou data.customer.mobile para um telefone dentro de outro objeto.
A URL do webhook não exige token de autenticação. Trate-a como uma credencial e não a exponha publicamente.

​
Requisição

Envie um POST com Content-Type: application/json para a URL do webhook.

​
Payload

Os dados do contato vão nos caminhos mapeados na condição. O identificador do contato, hashPessoa, vai sempre na raiz do JSON:
O hashPessoa não tem campo de mapeamento: ele só é lido na raiz do JSON. Se ele for enviado dentro de outro objeto, como contact, o Invenio não o encontra e identifica o contato pelos outros dados, o que pode gerar um contato duplicado.

​
Identificação do contato

  • Com hashPessoa: o fluxo é executado para o contato correspondente.
  • Sem hashPessoa: o contato é procurado pelos dados enviados (telefone, documento e e-mail). Se nenhum contato for encontrado, um novo é criado.
Sempre que o seu sistema já conhecer o contato, envie o hashPessoa: é o que garante que o fluxo rode no contato certo, sem criar duplicado. Dentro de um fluxo da IDR, ele está disponível na variável de sistema {{contactrobbuid}}.

​
Formato do telefone

  • Número do Brasil sem DDI: DDD + número, por exemplo 11999999999.
  • Número com DDI: prefixe com +, por exemplo +5511999999999.
Um número sem + é sempre tratado como brasileiro. Se enviar o DDI, use o + na frente.

​
Respostas

​
Uso dos dados no fluxo

O JSON recebido fica salvo no contato na variável {{lastapiresponse}}, que pode ser usada nas ações do fluxo, como Criar ou atualizar variável ou Enviar mensagem.