Integrações e API
Nesta página
Tudo o que o rastreador mostra também está disponível para outros sistemas. Webhooks são acionados conforme as execuções avançam, a API REST lê execuções e atua em tarefas, e o servidor MCP expõe o mesmo para assistentes de IA.
Webhooks
Adicione um webhook e defina Envia quando para Uma execução de fluxo de trabalho ou tarefa muda em API e webhooks. Ele recebe todos os fluxos de trabalho da equipe, ou apenas os fluxos de trabalho que usam um formulário específico quando você escolhe um. Cada chamada carrega o nome do evento, a execução e, quando houver, a tarefa e seu id de submissão:
| Evento | Quando |
|---|---|
workflow.run.started |
O formulário inicial foi enviado. |
workflow.run.restarted |
Uma execução rejeitada foi iniciada novamente a partir do botão Iniciar novamente. |
workflow.task.created |
Uma etapa foi atribuída a alguém. |
workflow.task.completed |
Uma etapa do formulário foi enviada. |
workflow.task.decided |
Uma aprovação foi decidida. O payload contém o resultado e o comentário. |
workflow.run.completed |
Todos os caminhos foram concluídos. |
workflow.run.rejected |
Um envio de volta encerrou a execução. |
workflow.run.cancelled |
Alguém cancelou a execução no rastreador ou através da API. |
Webhooks em nível de formulário nos formulários individuais continuam sendo acionados para suas submissões como antes.
API REST
A API v4 tem acesso de leitura e escrita a execuções e tarefas. Todas as rotas estão sob /api/v4/:
| Método e rota | O que faz |
|---|---|
GET workflow/<workflow>/definition/ |
As etapas e conexões de um fluxo de trabalho, somente leitura. |
GET workflow/<workflow>/runs/ |
As execuções do fluxo de trabalho, filtráveis por status, responsável e atraso, paginadas. |
GET workflow/run/<run>/ |
Uma execução com suas tarefas e sua linha do tempo. |
GET workflow/run/<run>/final-pdf/ |
O próprio arquivo PDF concluído: a cópia com a página de registro de aprovação quando houver, caso contrário, o próprio PDF do último formulário. |
POST workflow/run/<run>/cancel/ |
Cancela uma execução, com um motivo opcional. |
GET workflow/tasks/ |
Tarefas em todos os fluxos de trabalho, filtráveis por e-mail do responsável e status, para clientes estilo caixa de entrada. |
POST workflow/task/<task>/decide/ |
Decide uma tarefa de aprovação. O resultado e um comentário. |
POST workflow/task/<task>/nudge/ |
Reenvia o e-mail da tarefa. |
POST workflow/task/<task>/reassign/ |
Atribui a tarefa a um endereço de e-mail ou a um membro da equipe. |
As rotas mais antigas para enviar uma etapa de fluxo de trabalho e listar as submissões de um fluxo de trabalho por etapa permanecem inalteradas.
Quem pode ler e agir
As rotas REST e as ferramentas MCP seguem as mesmas regras de acesso que o rastreador:
- As execuções, tarefas, IDs de submissão, árvores e detalhes de execução de um fluxo de trabalho são listados ou lidos apenas para uma conta que seja Visualizador de Envio do Formulário em todos os formulários do fluxo de trabalho. Qualquer outra conta recebe uma resposta 403 que informa isso: “You need Form Submission Viewer permission on every form in this workflow.” Um fluxo de trabalho ou execução que não existe continua sendo informado como inexistente.
- A definição também se abre para quem pode projetar o fluxo de trabalho (Editor de Formulário em todos os formulários).
GET workflows/lista apenas os fluxos de trabalho que a conta pode projetar ou ver. - Incentivar, reatribuir e cancelar precisam do mesmo acesso que os botões do rastreador; reatribuir uma aprovação também exige Editor de Formulário em todos os formulários.
- Decidir uma aprovação exige que a conta seja o responsável pela aprovação.
- O link de uma tarefa aberta é incluído apenas para o próprio responsável pela tarefa e, em tarefas de formulário, para aqueles que podem agir na execução. A resposta a um incentivo não carrega link.
Ferramentas MCP
O servidor MCP do PlatoForms oferece aos assistentes de IA a mesma visão. list_workflow_runs (por fluxo de trabalho, status ou atraso), get_workflow_run, list_my_workflow_tasks, decide_workflow_task e nudge_workflow_task. Decidir uma tarefa exige que o usuário conectado seja um de seus responsáveis, para que um assistente possa aprovar em seu nome, mas não em nome de outra pessoa.