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

Integrations and API

Tabs

Everything the tracker shows is also available to other systems: webhooks fire as runs move, the REST API reads runs and acts on tasks, and the MCP server exposes the same to AI assistants.

Webhooks

Add a webhook with the event Workflow under API and webhooks. It receives every workflow of the team, or only the workflows that use a given form when you pick one. Each call carries the event name, the run and, where there is one, the task and its submission id:

Event When
workflow.run.started The start form was submitted.
workflow.run.restarted A rejected run was started again from the Start again button.
workflow.task.created A step was assigned to someone.
workflow.task.completed A form step was submitted.
workflow.task.decided An approval was decided; the payload has the outcome and comment.
workflow.run.completed Every path finished.
workflow.run.rejected A send-back ended the run.
workflow.run.cancelled Someone cancelled the run in the tracker or through the API.

Form-level webhooks on the individual forms keep firing for their submissions as before.

REST API

The API v4 has read and write access to runs and tasks. All routes sit under /api/v4/:

Method and route What it does
GET workflow/<workflow>/definition/ The steps and connections of a workflow, read-only.
GET workflow/<workflow>/runs/ The workflow’s runs, filterable by status, assignee and overdue, paged.
GET workflow/run/<run>/ One run with its tasks and its timeline.
GET workflow/run/<run>/final-pdf/ A time-limited link to the completed PDF, with the approval record page when there is one.
POST workflow/run/<run>/cancel/ Cancel a run, with an optional reason.
GET workflow/tasks/ Tasks across workflows, filterable by assignee email and status, for inbox-style clients.
POST workflow/task/<task>/decide/ Decide an approval task: the outcome and a comment.
POST workflow/task/<task>/nudge/ Resend the task’s email.
POST workflow/task/<task>/reassign/ Hand the task to an email address or a team member.

The older routes for submitting a workflow step and listing a workflow’s submissions by step are unchanged.

MCP tools

The PlatoForms MCP server gives AI assistants the same view: list_workflow_runs (by workflow, status or overdue), get_workflow_run, list_my_workflow_tasks, decide_workflow_task and nudge_workflow_task. Deciding a task requires the connected user to be one of its assignees or a team owner, so an assistant can approve on your behalf but not on someone else’s.

Is the content helpful?
Give feedback about this article