O FormFlow captura dados estruturados de conversas, armazena valores por escopo e disponibiliza essas informações para decisões.

Conceitos fundamentais

  • Variável (form_variables): campo tipado para capturar um dado (ex: email, telefone, nome)
  • Formulário (form_catalog): agrupa variáveis em um schema JSON para captura coordenada
  • Valor (form_items_values): estado corrente de uma variável capturada para um lead ou conversa
  • Resposta (form_responses): percentual de completude de um formulário para um lead/conversa
  • Escopo: define onde o valor é armazenado — lead, conversation, global ou form

Base URL

https://api.tolky.to/api/externalAPIs/public/formFlow

Endpoints de leitura usam POST (filtros via JSON). Mutações usam PUT.

Autenticação

Authorization: Bearer {TOKEN}

O hostId é derivado do token. Para multi-host, envie hostId no body.


Endpoints disponíveis

Consultas

Mutações

Captura com IA

CRUD Conversacional

Tempo real

  • WebSocket — eventos de captura, valores e respostas em tempo real

Raciocínio guiado