Documentação
Comece aqui
Conceitos
Oito palavras que explicam o resto da documentação — e como elas se encaixam.
Workspace ─ o seu ambiente: usuários, cadastros e dados. Nada atravessa. │ ├── Grupos de regras ─ os campos e as condições que decidem │ └── Versões ─ as fotos publicadas de cada grupo │ ├── Pipes ────────────── acionam N grupos sobre o mesmo item │ ├── fixam uma VERSÃO de cada grupo │ └── Cadeia de saída ─ o que fazer com a decisão │ ├── Fornecedores ─────── enriquecimento antes de decidir ├── Fontes de coleta ─── de onde os itens chegam ├── Distribuição ─────── reparte oportunidades entre parceiros ├── Links ────────────── endereços públicos que levam ao destino ├── Rotas de retorno ─── por onde o parceiro devolve o resultado │ ├── Histórico ────────── o que já aconteceu, item a item └── Relatórios ───────── os mesmos fatos em números e CSV
- Workspace
- O seu ambiente. Dono de tudo: usuários, grupos, Pipes, fornecedores, links. Nada atravessa a fronteira de um workspace.
- Grupo de regras
- Um contexto de decisão — “Fundo CLT”, “Banco XPTO”. Reúne os campos e a árvore de condições que respondem uma pergunta.
- Pipe
- A porta do produto. Avalia o MESMO item em vários grupos ao mesmo tempo, agrega os vereditos num só e despacha o resultado. É o que você aciona.
- Versão
- A foto congelada de um grupo publicado. A Pipe aponta para uma versão específica, então publicar não muda nada sozinho.
- Acionamento
- Uma entrada, contada uma vez. Um item que passa por uma Pipe de cinco grupos é UM acionamento — quem acionou as regras foi a Pipe. É a unidade cobrada.
- Item
- O que está sendo decidido — uma pessoa, um contrato, uma proposta. A chave do item (item_key) é o que o identifica em todas as telas.
- Oportunidade
- O que a decisão PRODUZ: um registro criado no destino (CRM, parceiro) por um elo da cadeia de saída. Aparece no Histórico como despacho.
- Desfecho
- O que o parceiro devolveu sobre aquela oportunidade: ganho, perdido, em andamento ou descartado. É o fim do ciclo.
Pipe é o que se aciona; grupo é peça dela
O acionamento passa pela Pipe. Chamar um grupo direto responde 409 — é o caminho de baixo nível, e ele fica aberto só em workspace que já integrava assim antes desta mudança. O motivo é a versão: a Pipe fixa o snapshot de cada grupo, então publicar uma regra não muda produção sem alguém pedir. Acionando o grupo direto não existe onde fixar, e a próxima publicação vale na chamada seguinte.
Três coisas parecidas que contam populações diferentes
Um ACIONAMENTO é o item que entrou. Uma VALIDAÇÃO é item × grupo — uma Pipe de três grupos gera três. Um DESPACHO é item × elo da cadeia de saída. Comparar os números entre si dá resultados sem sentido, e é por isso que o Histórico usa rótulos diferentes em cada aba.