O block Start é o trigger padrão de um workflow. Ele define as entradas que o workflow aceita e o executa a partir de três superfícies com o mesmo formato: uma execução manual no editor, um API deployment e um chat deployment.
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ê um default value a um campo para preencher previamente o formulário de execução manual. Os valores padrão são ignorados em execuções com deploy.
- Campos File aceitam uploads tanto do chat quanto de quem chama a API.
- Reordene os campos para controlar como eles aparecem no formulário do editor.
Saídas
Os campos que você definiu, mais o contexto da conversa quando o workflow executa a partir do chat:
| Saída | O 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, já preenchido com os valores padrão, para você testar de novo sem redigitar. Ao enviar, o workflow executa e os valores chegam em <start.fieldName>. Campos de arquivo enviam o upload direto para <start.fieldName>.
O Input Format se torna o corpo JSON da requisição. Cada campo faz parte do corpo, e o Studio converte os tipos primitivos na entrada. Campos de arquivo esperam objetos que referenciam arquivos já enviados, então faça o upload primeiro e depois invoque o workflow.
O block Start se vincula à conversa ativa: a mensagem mais recente preenche <start.input>, o id da sessão fica em <start.conversationId> e os anexos aparecem em <start.files>, ao lado de quaisquer campos do Input Format. Contexto estruturado extra passado no início 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 Studio executa o de maior prioridade: primeiro o trigger Start, depois um Schedule e então os triggers externos (webhooks e integrações). Ou seja, um workflow com um Start e um Webhook executa pelo Start quando você clica em Run. Executar um trigger externo manualmente, por outro lado, gera um payload simulado a partir do formato esperado, para que os blocks seguintes consigam resolver suas referências durante o teste.
Boas práticas
- Use o Start como ponto de entrada único quando um mesmo workflow atende chamadas por API e por chat.
- Prefira campos nomeados a JSON bruto. Campos tipados do Input Format são convertidos automaticamente e lidos pelo nome adiante.
- Valide cedo. Adicione um Condition logo depois do Start quando certos campos são obrigatórios para a execução dar certo.