Skip to main content
OPNForm logo
  • Category: forms & surveys
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 28
  • Triggers: 0
  • Slug: OPN_FORM
  • Version: 20261101_00

Tools

Slug: OPN_FORM_CANCEL_WORKSPACE_INVITECancel and remove a pending workspace invitation before it is accepted. Requires a personal access token with the workspace-users-write ability.

Input Parameters

integer
required
ID of the pending invite to cancel.
integer
required
ID of the workspace that owns the invite.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_CREATE_FORMCreate an OpnForm form in a workspace from a title, ordered field or layout blocks, and optional validated form settings. Optional retention settings permanently delete future submissions after the configured period. Requires a personal access token with the forms-write ability.

Input Parameters

string
required
Title displayed for the form.
object
Optional documented form settings. OpnForm’s supported defaults are used for omitted required appearance settings. Resource identity, title, workspace, and properties cannot be supplied here.
array
required
Ordered field and layout blocks. Every block requires a stable UUID id and a type; documented block-specific keys are preserved.
integer
required
ID of the workspace that will own the form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_CREATE_FORM_INTEGRATIONCreate a generic webhook or Make integration for an OpnForm form. This registers an external destination for future form submission data; an active integration can begin sending submissions to that destination immediately, while an inactive integration remains configured without delivery. Requires a personal access token with the manage-integrations ability.

Input Parameters

string ("active" | "inactive")
Whether delivery starts immediately. Use inactive to save the integration without sending events yet.
integer
required
Numeric ID of the form to connect.
string
required
Public HTTPS endpoint that will receive future form submission data. OpnForm rejects private callback URLs.
string
Optional Make scenario URL stored with a Make integration; omit for a generic webhook.
string ("webhook" | "make")
required
Integration provider: a generic webhook or OpnForm’s Make integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_CREATE_SUBMISSIONSubmit answers to a public OpnForm form. A completed submission may immediately send its data to active webhook or Make integrations; optionally save a partial submission with completion and campaign-attribution metadata.

Input Parameters

object
required
Map of form field IDs to submitted values. Obtain field IDs and their expected value types from Get Form.
string
required
Public slug of the form to submit.
boolean
Whether to save this as a partial rather than completed submission.
number
Optional time in seconds spent completing the form.
object
Optional allowlisted campaign and click attribution values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_CREATE_WORKSPACECreate an OpnForm workspace. Account workspace limits may reject creation even when the personal access token has write access. Requires a personal access token with the workspaces-write ability.

Input Parameters

string
required
Name for the new workspace.
string
Optional emoji or icon for the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_DELETE_FORMPermanently delete a form and all of its submissions by numeric ID. This irreversible operation cannot be undone. Requires a personal access token with the forms-write ability.

Input Parameters

integer
required
Numeric ID of the form to permanently delete together with all of its submissions. This cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_DELETE_FORM_INTEGRATIONPermanently remove a webhook integration from a form and stop its future deliveries. This operation cannot be undone. Requires a personal access token with the manage-integrations ability.

Input Parameters

integer
required
Numeric ID of the form that owns the integration.
integer
required
Numeric ID of the integration to permanently remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_DELETE_SUBMISSIONPermanently delete one submission from a form using both numeric IDs. This irreversible operation cannot be undone. Requires a personal access token with the forms-write ability.

Input Parameters

integer
required
Numeric ID of the form that owns the submission.
integer
required
Numeric ID of the submission to permanently delete. This cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_DELETE_SUBMISSIONSPermanently delete 1-25 submissions from one form through sequential provider requests. This operation is irreversible and not atomic: confirmed earlier deletions are not rolled back. Processing continues after item-local invalid or not-found responses, but stops after authentication, permission, rate-limit, server, or ambiguous transport failures. Requires a personal access token with the forms-write ability.

Input Parameters

integer
required
Numeric ID of the form that owns every submission.
array
required
Ordered unique IDs of 1-25 submissions to permanently delete. Each ID is deleted with a separate sequential provider request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_DELETE_WORKSPACEPermanently delete a workspace and its contained resources. This irreversible operation cannot be undone and requires repeating the workspace ID as explicit confirmation. Requires a personal access token with the workspaces-write ability.

Input Parameters

integer
required
Numeric ID of the workspace to permanently delete.
integer
required
Repeat workspace_id to confirm permanent deletion of this workspace and its contained resources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_GET_CURRENT_USERReturn the name and email of the OpnForm user associated with the connected personal access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_GET_FORMRetrieve a form by its public slug, including its complete field and layout definitions. Requires a personal access token with the forms-read ability.

Input Parameters

string
required
Public form slug returned by List Forms or Create Form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_INVITE_WORKSPACE_MEMBERAdd an existing OpnForm user to a workspace or email an invitation to a new user. Sending an invitation email cannot be undone. OpnForm Cloud requires a Pro plan and a personal access token with the workspace-users-write ability.

Input Parameters

string ("admin" | "user" | "readonly")
required
Workspace role to grant to the user.
string
required
Email address of the user to add or invite.
integer
required
ID of the workspace to add the member to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_INVITE_WORKSPACE_MEMBERSAdd or invite 1-10 users to one workspace through sequential provider requests. Each successful item may send an invitation email that cannot be undone, and the batch is not atomic. Processing continues after item-local validation failures but stops after authentication, permission, plan, rate-limit, server, or ambiguous transport failures. OpnForm Cloud requires a Pro plan and a personal access token with the workspace-users-write ability.

Input Parameters

array
required
Ordered list of 1-10 users to add or invite. Each item may send an irreversible invitation email through a separate sequential request.
integer
required
ID of the target workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_LIST_FORM_INTEGRATIONSList webhook and Make integrations configured for a form, including IDs, status, and endpoint configuration. Requires a personal access token with the manage-integrations ability.

Input Parameters

integer
required
Numeric ID of the form whose integrations to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_LIST_FORMSReturn one page of lightweight form summaries from a workspace. Pass the returned cursor back to continue; use Get Form for complete field definitions. Requires a personal access token with the forms-read ability.

Input Parameters

string
Continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
integer
Maximum form summaries to return in this page (1-100).
integer
required
ID of the workspace whose forms to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_LIST_INTEGRATION_EVENTSInspect past delivery attempts for one form integration, including the attempt date, Success or Error status, and a downstream HTTP status when available. Requires a personal access token with the manage-integrations ability.

Input Parameters

integer
required
Numeric ID of the form that owns the integration.
integer
required
Numeric ID of the integration whose delivery history to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_LIST_SUBMISSIONSReturn one searchable page of completed, partial, or all submissions for a form. Pass the returned cursor back unchanged to continue with the same filters. Requires a personal access token with the forms-read ability.

Input Parameters

string
Continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page with the same filters.
Optional text to match against submission field values.
string ("completed" | "partial" | "all")
Submission status to include.
integer
required
Numeric ID of the form whose submissions to list.
integer
Maximum submissions to return in this page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_LIST_WORKSPACE_INVITESList pending and accepted invitations for a workspace where the connected user is an administrator. Requires a personal access token with the workspaces-write ability.

Input Parameters

integer
required
ID of the admin-accessible workspace whose invitations to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_LIST_WORKSPACE_MEMBERSList members of a workspace with their user IDs, names, emails, and workspace roles. Requires a personal access token with the workspace-users-read ability.

Input Parameters

integer
required
ID of the workspace whose members to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_LIST_WORKSPACESList workspaces accessible to the connected user, including IDs, plan tier, role flags, usage counts, enabled features, and plan limits. Requires a personal access token with the workspaces-read ability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_REMOVE_WORKSPACE_MEMBERRemove a specified member from a workspace without deleting the member’s OpnForm account. Requires a personal access token with the workspace-users-write ability.

Input Parameters

integer
required
ID of the member to remove; obtain it from List Workspace Members.
integer
required
ID of the workspace to remove the member from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_RESEND_WORKSPACE_INVITESend another invitation email for an existing pending workspace invite. Each successful call sends an external email to the invite recipient and requires a personal access token with the workspace-users-write ability.

Input Parameters

integer
required
ID of the pending invite to resend.
integer
required
ID of the workspace that owns the invite.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_UPDATE_FORMUpdate an existing form’s field definitions and settings by numeric form ID, supplying the required current form state along with changes to preserve existing settings. Requires a personal access token with the forms-write ability.

Input Parameters

object
required
Complete provider-required form state plus any settings to change. Use Get Form first and pass its current required values to preserve existing state. The read-only id and slug fields are rejected.
integer
required
Numeric ID of the form to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_UPDATE_FORM_INTEGRATIONChange a generic webhook integration’s delivery URL or active status. Requires a personal access token with the manage-integrations ability.

Input Parameters

string ("active" | "inactive")
Optional new delivery status; omit to leave the current status unchanged.
integer
required
Numeric ID of the form that owns the integration.
string
New HTTPS endpoint that will receive form submission events.
integer
required
Numeric ID of the generic webhook integration to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_UPDATE_FORM_SUBMISSION_RETENTIONChange or disable a form’s automatic submission-retention policy, supplying required form state to preserve its fields and settings. Expired submissions are permanently deleted, and shortening the period can make existing submissions eligible for the next hourly cleanup; requires a personal access token with the forms-write ability.

Input Parameters

object
required
Complete provider-required form state. Use Get Form first and pass its current values so this retention update preserves fields and settings.
integer
required
Numeric ID of the form whose submission retention policy to change.
string
required
Calendar unit for retention, or null with retention_value=null to disable automatic deletion.
string
required
Number of retention units before submissions are permanently deleted, or null with retention_unit=null to disable automatic deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_UPDATE_WORKSPACEChange a workspace’s name and icon without affecting its membership or forms. Both values are required because OpnForm clears an omitted icon. Requires a personal access token with the workspaces-write ability.

Input Parameters

string
required
Workspace emoji or icon. Resubmit the existing value to preserve it, or pass an empty string to clear it; OpnForm clears omitted icons.
string
required
New workspace name. OpnForm requires it on every update.
integer
required
ID of the workspace to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPN_FORM_UPDATE_WORKSPACE_MEMBER_ROLEChange an existing workspace member’s role to admin, user, or readonly. Requires a personal access token with the workspace-users-write ability.

Input Parameters

string ("admin" | "user" | "readonly")
required
New workspace role for the member.
integer
required
ID of the member whose role to change.
integer
required
ID of the workspace containing the member.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not