OpnForm

App · 17 actions

Work with your OpnForm forms: list, create, update and delete forms, read and submit answers, and manage the webhooks that send each new submission to another app. Works on opnform.com and on a self-hosted OpnForm.

Actions

ActionWhat it does
Create formCreate a form in a workspace with the questions you list.
Create webhookHave OpnForm send every new submission of a form to an https address.
Delete formDelete a form together with its submissions.
Delete submissionDelete one submission from a form.
Delete webhookDelete a webhook so OpnForm stops sending submissions to it.
Get formGet one form with its settings and every field, including the field ids.
List form integrationsList the webhooks (and Make connections) a form sends its submissions to, with their ids, addresses and status.
List formsList the forms in a workspace with their slug, visibility and submission counts.
List submissionsList a form's submissions, optionally only completed or partial ones, or those containing some text.
List webhook deliveriesList a webhook's past deliveries with the result of each, to see whether submissions reached the address.
List workspace invitationsList the invitations sent to join a workspace, pending and accepted.
List workspace membersList the people in a workspace with their roles.
List workspacesList the workspaces you belong to, with their ids and names.
Submit formSend an answer to a form, as if someone filled it in.
Update formChange a form's title, visibility, button and thank-you text, closing time or submission limit.
Update submissionChange the answers of a submission.
Update webhookChange the address a webhook sends to, or switch it on or off.

Create form

Create a form in a workspace with the questions you list. It starts as a draft, so nobody can answer it until you make it public.

Inputs

Workspaceworkspace_idtextRequired
The workspace. Pick one, or give its id from an earlier step.
TitletitletextRequired
The form's title, shown at the top of the form.
Visibilityvisibilitytext
Who can open the form. Defaults to draft.One of: draft (Draft (only you can open it)), public (Public (anyone with the link)), closed (Closed (no new answers)).
Fieldsfieldslist
The form's questions, each with a 'name' and optionally a 'type' (text, email, number, url, phone_number, date, checkbox, rating, select or multi_select), 'required' (true or false), 'help' and, for select and multi_select, 'options' (a list of choices). Leave empty for one short text field called Name.

Outputs

formobject
The form
Example output
{
  "form": {
    "closes_at": null,
    "id": 12,
    "language": "en",
    "max_submissions_count": null,
    "properties": [
      {
        "help": "Your full name",
        "hidden": false,
        "id": "0b5f9f2e-6a4e-4b7d-9d51-3e1f9d0c1a11",
        "name": "Name",
        "placeholder": "Ada Lovelace",
        "required": true,
        "type": "text"
      }
    ],
    "redirect_url": null,
    "share_url": "https://opnform.com/forms/customer-feedback-x1y2z3",
    "slug": "customer-feedback-x1y2z3",
    "submit_button_text": "Submit",
    "submitted_text": "Thanks!",
    "theme": "default",
    "title": "Customer feedback",
    "visibility": "draft",
    "workspace_id": 1
  }
}

Create webhook

Have OpnForm send every new submission of a form to an https address.

Inputs

FormformtextRequired
The form. Pick one, or give its slug, id or share link from an earlier step.
Addresswebhook_urltextRequired
The https:// address OpnForm sends each submission to.
Statusstatustext
Whether it starts sending. Defaults to active.One of: active, inactive.

Outputs

integrationobject
The webhook
Example output
{
  "integration": {
    "data": {
      "webhook_url": "https://example.com/opnform-hook"
    },
    "form_id": 12,
    "id": 3,
    "integration_id": "webhook",
    "status": "active"
  }
}

Delete form

Delete a form together with its submissions.

Inputs

FormformtextRequired
The form. Pick one, or give its slug, id or share link from an earlier step.

Outputs

deletedtrue/false
Always true once the form is gone
form_idnumber
The form deleted
Example output
{
  "deleted": true,
  "form_id": 12
}

Delete submission

Delete one submission from a form.

Inputs

FormformtextRequired
The form. Pick one, or give its slug, id or share link from an earlier step.
Submission IDsubmission_idtextRequired
The submission's number, from 'List submissions'. It is not the code 'Submit form' returns.

Outputs

deletedtrue/false
Always true once the submission is gone
submission_idnumber
The submission deleted
Example output
{
  "deleted": true,
  "submission_id": 7
}

Delete webhook

Delete a webhook so OpnForm stops sending submissions to it.

Inputs

FormformtextRequired
The form. Pick one, or give its slug, id or share link from an earlier step.
Webhook IDintegration_idtextRequired
The webhook's id, from 'List form integrations' or 'Create webhook'.

Outputs

deletedtrue/false
Always true once the webhook is gone
integration_idnumber
The webhook deleted
Example output
{
  "deleted": true,
  "integration_id": 3
}

Get form

Get one form with its settings and every field, including the field ids.

Inputs

FormformtextRequired
The form. Pick one, or give its slug, id or share link from an earlier step.

Outputs

formobject
The form
Example output
{
  "form": {
    "closes_at": null,
    "id": 12,
    "language": "en",
    "max_submissions_count": null,
    "properties": [
      {
        "help": "Your full name",
        "hidden": false,
        "id": "0b5f9f2e-6a4e-4b7d-9d51-3e1f9d0c1a11",
        "name": "Name",
        "placeholder": "Ada Lovelace",
        "required": true,
        "type": "text"
      }
    ],
    "redirect_url": null,
    "share_url": "https://opnform.com/forms/customer-feedback-x1y2z3",
    "slug": "customer-feedback-x1y2z3",
    "submit_button_text": "Submit",
    "submitted_text": "Thanks!",
    "theme": "default",
    "title": "Customer feedback",
    "visibility": "draft",
    "workspace_id": 1
  }
}

List form integrations

List the webhooks (and Make connections) a form sends its submissions to, with their ids, addresses and status.

Inputs

FormformtextRequired
The form. Pick one, or give its slug, id or share link from an earlier step.

Outputs

countnumber
How many there are
form_idnumber
The form's id
integrationslist
The integrations
Example output
{
  "count": 1,
  "form_id": 12,
  "integrations": [
    {
      "data": {
        "webhook_url": "https://example.com/opnform-hook"
      },
      "form_id": 12,
      "id": 3,
      "integration_id": "webhook",
      "status": "active"
    }
  ]
}

List forms

List the forms in a workspace with their slug, visibility and submission counts. Returns one page; ask for the next page number while 'has_more' is true.

Inputs

Workspaceworkspace_idtextRequired
The workspace. Pick one, or give its id from an earlier step.
Pagepagenumber
Which page to return, starting at 1. Defaults to the first.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100.From 1 to 100.

Outputs

countnumber
How many records are in this page
current_pagenumber
This page's number
formslist
The forms
has_moretrue/false
True when a later page exists; ask for the next page number
last_pagenumber
The last page's number
totalnumber
How many records there are in all
Example output
{
  "count": 1,
  "current_page": 1,
  "forms": [
    {
      "closes_at": null,
      "created_at": "2026-10-15T09:00:00Z",
      "id": 12,
      "is_closed": false,
      "max_submissions_count": null,
      "share_url": "https://opnform.com/forms/customer-feedback-x1y2z3",
      "slug": "customer-feedback-x1y2z3",
      "submissions_count": 3,
      "title": "Customer feedback",
      "updated_at": "2026-10-16T09:00:00Z",
      "views_count": 10,
      "visibility": "draft",
      "workspace_id": 1
    }
  ],
  "has_more": false,
  "last_page": 1,
  "total": 1
}

List submissions

List a form's submissions, optionally only completed or partial ones, or those containing some text. Returns one page; ask for the next page number while 'has_more' is true. Each answer is keyed by the field's id.

Inputs

FormformtextRequired
The form. Pick one, or give its slug, id or share link from an earlier step.
Statusstatustext
Which submissions to include. Defaults to all.One of: all (All (default)), completed, partial.
Searchsearchtext
Only submissions with an answer containing this text.
Pagepagenumber
Which page to return, starting at 1. Defaults to the first.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100.From 1 to 100.

Outputs

countnumber
How many records are in this page
current_pagenumber
This page's number
form_idnumber
The form's id
has_moretrue/false
True when a later page exists; ask for the next page number
last_pagenumber
The last page's number
submissionslist
The submissions
totalnumber
How many records there are in all
Example output
{
  "count": 1,
  "current_page": 1,
  "form_id": 12,
  "has_more": false,
  "last_page": 1,
  "submissions": [
    {
      "completion_time": 14,
      "data": {
        "0b5f9f2e-6a4e-4b7d-9d51-3e1f9d0c1a11": "Ada",
        "id": 7,
        "status": "completed"
      },
      "form_id": 12,
      "id": 7,
      "meta": {
        "attribution": {}
      }
    }
  ],
  "total": 1
}

List webhook deliveries

List a webhook's past deliveries with the result of each, to see whether submissions reached the address.

Inputs

FormformtextRequired
The form. Pick one, or give its slug, id or share link from an earlier step.
Webhook IDintegration_idtextRequired
The webhook's id, from 'List form integrations' or 'Create webhook'.

Outputs

countnumber
How many records are in this page
current_pagenumber
This page's number
eventslist
The deliveries
has_moretrue/false
True when a later page exists; ask for the next page number
last_pagenumber
The last page's number
totalnumber
How many records there are in all
Example output
{
  "count": 1,
  "current_page": 1,
  "events": [
    {
      "can_retry": false,
      "data": {
        "submission_id": 7
      },
      "date": "2026-10-16 09:00",
      "id": 21,
      "retry_unavailable_reason": "Only failed events can be retried.",
      "status": "Success",
      "tracking_id": null
    }
  ],
  "has_more": false,
  "last_page": 1,
  "total": 1
}

List workspace invitations

List the invitations sent to join a workspace, pending and accepted. Needs a workspace admin's token.

Inputs

Workspaceworkspace_idtextRequired
The workspace. Pick one, or give its id from an earlier step.

Outputs

countnumber
How many records are in this page
current_pagenumber
This page's number
has_moretrue/false
True when a later page exists; ask for the next page number
inviteslist
The invitations
last_pagenumber
The last page's number
totalnumber
How many records there are in all
Example output
{
  "count": 1,
  "current_page": 1,
  "has_more": false,
  "invites": [
    {
      "email": "new@example.com",
      "id": 2,
      "role": "user",
      "status": "pending",
      "valid_until": "2026-11-15T09:00:00Z"
    }
  ],
  "last_page": 1,
  "total": 1
}

List workspace members

List the people in a workspace with their roles.

Inputs

Workspaceworkspace_idtextRequired
The workspace. Pick one, or give its id from an earlier step.

Outputs

countnumber
How many records are in this page
current_pagenumber
This page's number
has_moretrue/false
True when a later page exists; ask for the next page number
last_pagenumber
The last page's number
totalnumber
How many records there are in all
userslist
The members
Example output
{
  "count": 1,
  "current_page": 1,
  "has_more": false,
  "last_page": 1,
  "total": 1,
  "users": [
    {
      "email": "jo@example.com",
      "id": 4,
      "name": "Jo Bloggs",
      "role": "admin"
    }
  ]
}

List workspaces

List the workspaces you belong to, with their ids and names.

Inputs

None.

Outputs

countnumber
How many records are in this page
current_pagenumber
This page's number
has_moretrue/false
True when a later page exists; ask for the next page number
last_pagenumber
The last page's number
totalnumber
How many records there are in all
workspaceslist
The workspaces
Example output
{
  "count": 1,
  "current_page": 1,
  "has_more": false,
  "last_page": 1,
  "total": 1,
  "workspaces": [
    {
      "icon": "\ud83d\ude80",
      "id": 1,
      "name": "Marketing"
    }
  ]
}

Submit form

Send an answer to a form, as if someone filled it in. The form must be public, and the answers must satisfy its required fields.

Inputs

FormformtextRequired
The form. Pick one, or give its slug, id or share link from an earlier step.
AnswersanswersobjectRequired
Each field's name with the answer, for example {"Name": "Ada", "Email": "ada@example.com"}. The field ids are looked up for you.
Save as partialis_partialtrue/false
Turn on to save the answers as an unfinished submission, which skips the required-field check.

Outputs

is_first_submissiontrue/false
True if this was the form's first submission
messagetext
OpnForm's confirmation
submission_idtext
OpnForm's code for the submission. Use 'List submissions' to get the number other steps take.
submittedtrue/false
True once OpnForm saved it
Example output
{
  "is_first_submission": false,
  "message": "Form submission saved.",
  "submission_id": "Xa9bQ",
  "submitted": true
}

Update form

Change a form's title, visibility, button and thank-you text, closing time or submission limit. Anything left empty stays as it is.

Inputs

FormformtextRequired
The form. Pick one, or give its slug, id or share link from an earlier step.
Titletitletext
A new title. Leave empty to keep it.
Visibilityvisibilitytext
Open, draft or close the form. Leave empty to keep it.One of: draft (Draft (only you can open it)), public (Public (anyone with the link)), closed (Closed (no new answers)).
Submit button textsubmit_button_texttext
The text on the button that sends the form, at most 50 characters.
Thank-you messagesubmitted_texttext
The message shown after someone submits, at most 2000 characters.
Closes atcloses_atdate and time
When the form stops taking answers.
Submission limitmax_submissions_countnumber
Stop taking answers after this many submissions.At least 1.

Outputs

formobject
The form
Example output
{
  "form": {
    "closes_at": null,
    "id": 12,
    "language": "en",
    "max_submissions_count": null,
    "properties": [
      {
        "help": "Your full name",
        "hidden": false,
        "id": "0b5f9f2e-6a4e-4b7d-9d51-3e1f9d0c1a11",
        "name": "Name",
        "placeholder": "Ada Lovelace",
        "required": true,
        "type": "text"
      }
    ],
    "redirect_url": null,
    "share_url": "https://opnform.com/forms/customer-feedback-x1y2z3",
    "slug": "customer-feedback-x1y2z3",
    "submit_button_text": "Submit",
    "submitted_text": "Thanks!",
    "theme": "default",
    "title": "Customer feedback 2026",
    "visibility": "draft",
    "workspace_id": 1
  }
}

Update submission

Change the answers of a submission. Give every required field's answer again, not only the one that changes.

Inputs

FormformtextRequired
The form. Pick one, or give its slug, id or share link from an earlier step.
Submission IDsubmission_idtextRequired
The submission's number, from 'List submissions'. It is not the code 'Submit form' returns.
AnswersanswersobjectRequired
Each field's name with the answer, for example {"Name": "Ada", "Email": "ada@example.com"}. The field ids are looked up for you.

Outputs

submissionobject
The submission
Example output
{
  "submission": {
    "completion_time": 14,
    "data": {
      "0b5f9f2e-6a4e-4b7d-9d51-3e1f9d0c1a11": "Ada",
      "id": 7,
      "status": "completed"
    },
    "form_id": 12,
    "id": 7,
    "meta": {
      "attribution": {}
    }
  }
}

Update webhook

Change the address a webhook sends to, or switch it on or off. Anything left empty stays as it is.

Inputs

FormformtextRequired
The form. Pick one, or give its slug, id or share link from an earlier step.
Webhook IDintegration_idtextRequired
The webhook's id, from 'List form integrations' or 'Create webhook'.
New addresswebhook_urltext
The https:// address OpnForm sends each submission to.
Statusstatustext
Turn the webhook on or off.One of: active, inactive.

Outputs

integrationobject
The webhook
Example output
{
  "integration": {
    "data": {
      "webhook_url": "https://example.com/opnform-hook"
    },
    "form_id": 12,
    "id": 3,
    "integration_id": "webhook",
    "status": "inactive"
  }
}

On this page