PlatoForms User Guide
Ctrl+K

  • Form Builder

    Creating an Online Form for an Existing PDF

  • Custom Domain

    With Builder you can build three types of forms: online web forms, online PDF forms, and master forms.

  • Master Form Builder

    you will arrive at the Form Builder. On the form Builder, there are three main sections:

What's new? API Docs

Integrationen und API

Auf dieser Seite

Alles, was der Tracker zeigt, ist auch für andere Systeme verfügbar. Webhooks werden ausgelöst, wenn Abläufe sich bewegen. Die REST-API liest Abläufe und bearbeitet Aufgaben, und der MCP-Server stellt dasselbe für KI-Assistenten bereit.

Webhooks

Fügen Sie einen Webhook hinzu und setzen Sie Sendet, wenn auf Ein Workflow-Lauf oder eine Aufgabe ändert sich unter API und Webhooks. Er empfängt jeden Workflow des Teams oder nur die Workflows, die ein bestimmtes Formular verwenden, wenn Sie eines auswählen. Jeder Aufruf enthält den Ereignisnamen, den Ablauf und, falls vorhanden, die Aufgabe und deren Einreichungs-ID:

Ereignis Wann
workflow.run.started Das Startformular wurde eingereicht.
workflow.run.restarted Ein abgelehnter Ablauf wurde erneut über die Erneut starten-Schaltfläche gestartet.
workflow.task.created Ein Schritt wurde jemandem zugewiesen.
workflow.task.completed Ein Formularschritt wurde eingereicht.
workflow.task.decided Eine Genehmigung wurde entschieden. Die Nutzlast enthält das Ergebnis und den Kommentar.
workflow.run.completed Jeder Pfad wurde abgeschlossen.
workflow.run.rejected Eine Rücksendung beendete den Ablauf.
workflow.run.cancelled Jemand hat den Ablauf im Tracker oder über die API abgebrochen.

Formularspezifische Webhooks auf den einzelnen Formularen werden weiterhin für ihre Einreichungen ausgelöst.

REST API

Die API v4 bietet Lese- und Schreibzugriff auf Abläufe und Aufgaben. Alle Routen befinden sich unter /api/v4/:

Methode und Route Was sie tut
GET workflow/<workflow>/definition/ Die Schritte und Verbindungen eines Workflows, nur lesbar.
GET workflow/<workflow>/runs/ Die Abläufe des Workflows, filterbar nach Status, Zuständiger und überfällig, mit Seitenangabe.
GET workflow/run/<run>/ Ein Ablauf mit seinen Aufgaben und seinem Zeitverlauf.
GET workflow/run/<run>/final-pdf/ Die abgeschlossene PDF-Datei selbst: die Kopie mit der Genehmigungsaufzeichnungsseite, falls vorhanden, andernfalls das eigene PDF des letzten Formulars.
POST workflow/run/<run>/cancel/ Einen Ablauf abbrechen, mit optionalem Grund.
GET workflow/tasks/ Aufgaben über Workflows hinweg, filterbar nach E-Mail des Zuständigen und Status, für Inbox-ähnliche Clients.
POST workflow/task/<task>/decide/ Eine Genehmigungsaufgabe entscheiden: das Ergebnis und ein Kommentar.
POST workflow/task/<task>/nudge/ Die E-Mail der Aufgabe erneut senden.
POST workflow/task/<task>/reassign/ Die Aufgabe an eine E-Mail-Adresse oder ein Teammitglied übergeben.

Die älteren Routen zum Einreichen eines Workflow-Schritts und zum Auflisten der Einreichungen eines Workflows nach Schritt bleiben unverändert.

Wer lesen und handeln kann

Die REST-Routen und die MCP-Tools folgen denselben Zugriffsregeln wie der Tracker:

  • Die Läufe, Aufgaben, Einreichungs-IDs, Bäume und Laufdetails eines Workflows werden nur für ein Konto aufgelistet oder gelesen, das Formulareinsicht-Betrachter für jedes Formular des Workflows ist. Jedes andere Konto erhält eine 403-Antwort, die das sagt: “You need Form Submission Viewer permission on every form in this workflow.” Ein Workflow oder Lauf, der nicht existiert, wird weiterhin als nicht existierend gemeldet.
  • Die Definition öffnet sich auch für diejenigen, die den Workflow entwerfen dürfen (Formular-Editor für jedes Formular). GET workflows/ listet nur die Workflows auf, die das Konto entwerfen oder sehen darf.
  • Anstoßen, Neu zuweisen und Abbrechen erfordern denselben Zugriff wie die Schaltflächen des Trackers; das Neuzuweisen einer Genehmigung erfordert außerdem Formular-Editor für jedes Formular.
  • Um über eine Genehmigung zu entscheiden, muss das Konto der Zuständige dieser Genehmigung sein.
  • Der Link einer offenen Aufgabe ist nur für den eigenen Beauftragten der Aufgabe und bei Formularaufgaben für diejenigen enthalten, die auf den Lauf reagieren dürfen. Die Antwort auf ein Anstoßen enthält keinen Link.

MCP-Tools

Der PlatoForms MCP-Server bietet KI-Assistenten dieselbe Ansicht: list_workflow_runs (nach Workflow, Status oder überfällig), get_workflow_run, list_my_workflow_tasks, decide_workflow_task und nudge_workflow_task. Um eine Aufgabe zu entscheiden, muss der verbundene Benutzer einer der Zuständigen sein, sodass ein Assistent in Ihrem Namen, aber nicht im Namen eines anderen genehmigen kann.

Is the content helpful?
Give feedback about this article