Reference

Start

O bloco Start é o trigger padrão de um workflow. Ele define as entradas que o workflow recebe e o executa a partir de três superfícies com o mesmo formato: uma execução manual no editor, um deployment de API e um deployment de chat.

Todo workflow começa com um bloco Start no slot de trigger. Mantenha-o quando um único ponto de entrada deve servir execuções pelo editor, API e chat. Troque por um trigger Webhook ou Schedule quando o workflow deve rodar só em um evento ou em um timer.

Input Format

Defina os campos que o workflow aceita. Cada campo tem um nome e um tipo — string, number, boolean, object, array ou files — e fica disponível adiante como <start.fieldName>. Um campo customerId é lido como <start.customerId>.

  • Dê a um campo um valor padrão para pré-preencher o formulário de execução manual. Defaults são ignorados em execuções publicadas.
  • Campos de arquivo aceitam uploads tanto de callers de chat quanto de API.
  • Reordene os campos para controlar como eles aparecem no formulário do editor.

Saídas

Os campos que você define, mais o contexto da conversa quando o workflow roda pelo chat:

SaídaO que é
<start.fieldName>Cada campo do Input Format, pelo nome
<start.input>A mensagem mais recente do usuário (somente chat)
<start.conversationId>O id da sessão ativa (somente chat)
<start.files>Anexos do chat (somente chat)

Por ponto de entrada

Run renderiza o Input Format como um formulário, pré-preenchido com quaisquer valores padrão, para você retestar sem redigitar. Ao enviar, o workflow roda e os valores chegam em <start.fieldName>. Campos de arquivo fazem upload direto para <start.fieldName>.

O Input Format vira o corpo JSON da requisição. Cada campo faz parte do corpo, e o Zoen faz a coerção dos tipos primitivos na entrada. Campos de arquivo esperam objetos que referenciam arquivos enviados, então faça o upload primeiro e depois invoque o workflow.

O bloco Start se vincula à conversa ativa: a mensagem mais recente preenche <start.input>, o id da sessão é <start.conversationId>, e os anexos aparecem em <start.files>, junto com quaisquer campos do Input Format. Contexto estruturado extra passado no lançamento se mescla nas saídas <start.fieldName> correspondentes.

Múltiplos triggers

Um workflow pode ter mais de um trigger. Quando você clica em Run no editor, o Zoen executa o de maior prioridade: o trigger Start primeiro, depois um Schedule, depois triggers externos (webhooks e integrações). Assim, um workflow com Start e Webhook roda a partir do Start quando você clica em Run. Rodar um trigger externo manualmente gera um payload mock a partir do formato esperado, para que os blocos seguintes consigam resolver as referências enquanto você testa.

Boas práticas

  • Use o Start como único ponto de entrada quando um workflow atende callers de API e de chat.
  • Prefira campos nomeados a JSON bruto. Campos tipados do Input Format passam por coerção automaticamente e são lidos pelo nome adiante.
  • Valide cedo. Adicione um Condition logo após o Start quando certos campos forem obrigatórios para a execução ter sucesso.

On this page