Intégrations et API
Sur cette page
Tout ce que le traqueur montre est également disponible pour d’autres systèmes : les webhooks s’activent au fur et à mesure que les exécutions avancent, l’API REST lit les exécutions et agit sur les tâches, et le serveur MCP expose la même chose aux assistants IA.
Webhooks
Ajoutez un webhook et définissez Envoie lorsque sur Un flux de travail ou une tâche change sous API et webhooks. Il reçoit chaque flux de travail de l’équipe, ou seulement les flux de travail qui utilisent un formulaire donné lorsque vous en choisissez un. Chaque appel transporte le nom de l’événement, l’exécution et, le cas échéant, la tâche et son identifiant de soumission :
| Événement | Quand |
|---|---|
workflow.run.started |
Le formulaire de départ a été soumis. |
workflow.run.restarted |
Une exécution rejetée a été relancée depuis le bouton Recommencer. |
workflow.task.created |
Une étape a été assignée à quelqu’un. |
workflow.task.completed |
Une étape de formulaire a été soumise. |
workflow.task.decided |
Une approbation a été décidée ; la charge utile contient le résultat et le commentaire. |
workflow.run.completed |
Chaque chemin a été terminé. |
workflow.run.rejected |
Un renvoi a mis fin à l’exécution. |
workflow.run.cancelled |
Quelqu’un a annulé l’exécution dans le traqueur ou via l’API. |
Les webhooks au niveau des formulaires sur les formulaires individuels continuent de s’activer pour leurs soumissions comme auparavant.
API REST
L’API v4 a un accès en lecture et écriture aux exécutions et aux tâches. Toutes les routes se trouvent sous /api/v4/ :
| Méthode et route | Ce qu’elle fait |
|---|---|
GET workflow/<workflow>/definition/ |
Les étapes et connexions d’un flux de travail, en lecture seule. |
GET workflow/<workflow>/runs/ |
Les exécutions du flux de travail, filtrables par statut, assigné et en retard, paginées. |
GET workflow/run/<run>/ |
Une exécution avec ses tâches et sa chronologie. |
GET workflow/run/<run>/final-pdf/ |
Le fichier PDF complété lui-même : la copie avec la page d’enregistrement d’approbation lorsqu’il y en a une, sinon le propre PDF du dernier formulaire. |
POST workflow/run/<run>/cancel/ |
Annuler une exécution, avec une raison optionnelle. |
GET workflow/tasks/ |
Tâches à travers les flux de travail, filtrables par email de l’assigné et statut, pour les clients de type boîte de réception. |
POST workflow/task/<task>/decide/ |
Décider d’une tâche d’approbation : le résultat et un commentaire. |
POST workflow/task/<task>/nudge/ |
Renvoyer l’email de la tâche. |
POST workflow/task/<task>/reassign/ |
Transférer la tâche à une adresse email ou à un membre de l’équipe. |
Les anciennes routes pour soumettre une étape de flux de travail et lister les soumissions d’un flux de travail par étape restent inchangées.
Qui peut lire et agir
Les routes REST et les outils MCP suivent les mêmes règles d’accès que le traqueur :
- Les exécutions, tâches, identifiants de soumission, arbres et détails d’exécution d’un flux de travail sont listés ou lus uniquement pour un compte qui est Visualiseur de soumission de formulaire sur chaque formulaire du flux de travail. Tout autre compte reçoit une réponse 403 qui l’indique : “You need Form Submission Viewer permission on every form in this workflow.” Un flux de travail ou une exécution qui n’existe pas est toujours signalé comme inexistant.
- La définition s’ouvre également pour quiconque peut concevoir le flux de travail (Éditeur de formulaire sur chaque formulaire).
GET workflows/liste uniquement les flux de travail que le compte peut concevoir ou voir. - Les incitations, réaffectations et annulations nécessitent le même accès que les boutons du traqueur ; réattribuer une approbation nécessite aussi Éditeur de formulaire sur chaque formulaire.
- Décider d’une approbation nécessite que le compte soit l’assigné de cette approbation.
- Le lien d’une tâche ouverte est inclus uniquement pour le propre assigné de la tâche et, sur les tâches de formulaire, pour ceux qui peuvent agir sur l’exécution. La réponse à une incitation ne contient aucun lien.
Outils MCP
Le serveur MCP de PlatoForms offre aux assistants IA la même vue : list_workflow_runs (par flux de travail, statut ou en retard), get_workflow_run, list_my_workflow_tasks, decide_workflow_task et nudge_workflow_task. Décider d’une tâche nécessite que l’utilisateur connecté soit l’un de ses assignés, de sorte qu’un assistant peut approuver en votre nom mais pas au nom de quelqu’un d’autre.