# OpnForm

> 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.

App · 17 actions. Web page: https://docs.lodol.com/docs/integrations/opnform

## Actions

### 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**

- Workspace (`workspace_id`, text, required): The workspace. Pick one, or give its id from an earlier step.
- Title (`title`, text, required): The form's title, shown at the top of the form.
- Visibility (`visibility`, text): 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)).
- Fields (`fields`, list): 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**

- `form` (object): The form

**Example output**

```json
{
  "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**

- Form (`form`, text, required): The form. Pick one, or give its slug, id or share link from an earlier step.
- Address (`webhook_url`, text, required): The https:// address OpnForm sends each submission to.
- Status (`status`, text): Whether it starts sending. Defaults to active. One of: `active`, `inactive`.

**Outputs**

- `integration` (object): The webhook

**Example output**

```json
{
  "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**

- Form (`form`, text, required): The form. Pick one, or give its slug, id or share link from an earlier step.

**Outputs**

- `deleted` (true/false): Always true once the form is gone
- `form_id` (number): The form deleted

**Example output**

```json
{
  "deleted": true,
  "form_id": 12
}
```

### Delete submission

Delete one submission from a form.

**Inputs**

- Form (`form`, text, required): The form. Pick one, or give its slug, id or share link from an earlier step.
- Submission ID (`submission_id`, text, required): The submission's number, from 'List submissions'. It is not the code 'Submit form' returns.

**Outputs**

- `deleted` (true/false): Always true once the submission is gone
- `submission_id` (number): The submission deleted

**Example output**

```json
{
  "deleted": true,
  "submission_id": 7
}
```

### Delete webhook

Delete a webhook so OpnForm stops sending submissions to it.

**Inputs**

- Form (`form`, text, required): The form. Pick one, or give its slug, id or share link from an earlier step.
- Webhook ID (`integration_id`, text, required): The webhook's id, from 'List form integrations' or 'Create webhook'.

**Outputs**

- `deleted` (true/false): Always true once the webhook is gone
- `integration_id` (number): The webhook deleted

**Example output**

```json
{
  "deleted": true,
  "integration_id": 3
}
```

### Get form

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

**Inputs**

- Form (`form`, text, required): The form. Pick one, or give its slug, id or share link from an earlier step.

**Outputs**

- `form` (object): The form

**Example output**

```json
{
  "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**

- Form (`form`, text, required): The form. Pick one, or give its slug, id or share link from an earlier step.

**Outputs**

- `count` (number): How many there are
- `form_id` (number): The form's id
- `integrations` (list): The integrations

**Example output**

```json
{
  "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**

- Workspace (`workspace_id`, text, required): The workspace. Pick one, or give its id from an earlier step.
- Page (`page`, number): Which page to return, starting at 1. Defaults to the first. At least 1.
- Page size (`per_page`, number): How many to return, 1 to 100. From 1 to 100.

**Outputs**

- `count` (number): How many records are in this page
- `current_page` (number): This page's number
- `forms` (list): The forms
- `has_more` (true/false): True when a later page exists; ask for the next page number
- `last_page` (number): The last page's number
- `total` (number): How many records there are in all

**Example output**

```json
{
  "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**

- Form (`form`, text, required): The form. Pick one, or give its slug, id or share link from an earlier step.
- Status (`status`, text): Which submissions to include. Defaults to all. One of: `all` (All (default)), `completed`, `partial`.
- Search (`search`, text): Only submissions with an answer containing this text.
- Page (`page`, number): Which page to return, starting at 1. Defaults to the first. At least 1.
- Page size (`per_page`, number): How many to return, 1 to 100. From 1 to 100.

**Outputs**

- `count` (number): How many records are in this page
- `current_page` (number): This page's number
- `form_id` (number): The form's id
- `has_more` (true/false): True when a later page exists; ask for the next page number
- `last_page` (number): The last page's number
- `submissions` (list): The submissions
- `total` (number): How many records there are in all

**Example output**

```json
{
  "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**

- Form (`form`, text, required): The form. Pick one, or give its slug, id or share link from an earlier step.
- Webhook ID (`integration_id`, text, required): The webhook's id, from 'List form integrations' or 'Create webhook'.

**Outputs**

- `count` (number): How many records are in this page
- `current_page` (number): This page's number
- `events` (list): The deliveries
- `has_more` (true/false): True when a later page exists; ask for the next page number
- `last_page` (number): The last page's number
- `total` (number): How many records there are in all

**Example output**

```json
{
  "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**

- Workspace (`workspace_id`, text, required): The workspace. Pick one, or give its id from an earlier step.

**Outputs**

- `count` (number): How many records are in this page
- `current_page` (number): This page's number
- `has_more` (true/false): True when a later page exists; ask for the next page number
- `invites` (list): The invitations
- `last_page` (number): The last page's number
- `total` (number): How many records there are in all

**Example output**

```json
{
  "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**

- Workspace (`workspace_id`, text, required): The workspace. Pick one, or give its id from an earlier step.

**Outputs**

- `count` (number): How many records are in this page
- `current_page` (number): This page's number
- `has_more` (true/false): True when a later page exists; ask for the next page number
- `last_page` (number): The last page's number
- `total` (number): How many records there are in all
- `users` (list): The members

**Example output**

```json
{
  "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**

- `count` (number): How many records are in this page
- `current_page` (number): This page's number
- `has_more` (true/false): True when a later page exists; ask for the next page number
- `last_page` (number): The last page's number
- `total` (number): How many records there are in all
- `workspaces` (list): The workspaces

**Example output**

```json
{
  "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**

- Form (`form`, text, required): The form. Pick one, or give its slug, id or share link from an earlier step.
- Answers (`answers`, object, required): 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 partial (`is_partial`, true/false): Turn on to save the answers as an unfinished submission, which skips the required-field check.

**Outputs**

- `is_first_submission` (true/false): True if this was the form's first submission
- `message` (text): OpnForm's confirmation
- `submission_id` (text): OpnForm's code for the submission. Use 'List submissions' to get the number other steps take.
- `submitted` (true/false): True once OpnForm saved it

**Example output**

```json
{
  "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**

- Form (`form`, text, required): The form. Pick one, or give its slug, id or share link from an earlier step.
- Title (`title`, text): A new title. Leave empty to keep it.
- Visibility (`visibility`, text): 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 text (`submit_button_text`, text): The text on the button that sends the form, at most 50 characters.
- Thank-you message (`submitted_text`, text): The message shown after someone submits, at most 2000 characters.
- Closes at (`closes_at`, date and time): When the form stops taking answers.
- Submission limit (`max_submissions_count`, number): Stop taking answers after this many submissions. At least 1.

**Outputs**

- `form` (object): The form

**Example output**

```json
{
  "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**

- Form (`form`, text, required): The form. Pick one, or give its slug, id or share link from an earlier step.
- Submission ID (`submission_id`, text, required): The submission's number, from 'List submissions'. It is not the code 'Submit form' returns.
- Answers (`answers`, object, required): Each field's name with the answer, for example {"Name": "Ada", "Email": "ada@example.com"}. The field ids are looked up for you.

**Outputs**

- `submission` (object): The submission

**Example output**

```json
{
  "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**

- Form (`form`, text, required): The form. Pick one, or give its slug, id or share link from an earlier step.
- Webhook ID (`integration_id`, text, required): The webhook's id, from 'List form integrations' or 'Create webhook'.
- New address (`webhook_url`, text): The https:// address OpnForm sends each submission to.
- Status (`status`, text): Turn the webhook on or off. One of: `active`, `inactive`.

**Outputs**

- `integration` (object): The webhook

**Example output**

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