View as Markdown
Form.io icon

Form.io ACTION

Create Form Action

Attach an action (e.g. email, webhook, save) to a Form.io form. Use List Forms to find the form ID and List Form Actions to review existing actions. The settings prop is a JSON-string object specific to the action type. Example: actionType webhook, title Notify endpoint, handler [after], method [create], settings {"url":"https://example.com/hook","method":"post"} → returns the new action with its _id. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Form.io account once, then configure and run Create Form Action from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "form_io-create-form-action",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    form_io: { authProvisionId: "apn_xxxxxxx" },
    formId: "Form ID",
    actionType: "Action Type",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Form Action inputs
Property Type Description
formId Form ID string
The _id of the form. Run List Forms first to obtain valid form IDs.
Required
actionType Action Type string
The Form.io action type to attach — e.g. webhook, email, save, login, role. This selects which built-in action runs; it is NOT a display label (use title for that).
Required
title Title string
The human-readable title of the action.
Required
handler Handler string[]
When the action runs. Values: before, after.
Required
method Method string[]
Which operations trigger the action. Values: create, update, read, delete, index.
Required
priority Priority integer
Execution priority of the action.
Optional
settings Settings string
JSON-string object of action-specific settings. Example: {"transport":"default","from":"noreply@example.com","to":"admin@example.com","subject":"New submission"}. Parsed from a JSON string before sending.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
form_io-create-form-action
Version
0.0.1
App
Form.io
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes