Skip to main content
GET
/
open
/
forms
/
{form}
/
integrations
List Form Integrations
curl --request GET \
  --url https://api.opnform.com/open/forms/{form}/integrations \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 42,
    "form_id": 123,
    "integration_id": "webhook",
    "status": "active",
    "data": {
      "webhook_url": "https://example.com/opnform-hook"
    }
  },
  {
    "id": 43,
    "form_id": 123,
    "integration_id": "webhook",
    "status": "inactive",
    "data": {
      "webhook_url": "https://old-endpoint.com/hook"
    }
  }
]

List Form Integrations

Retrieve all integrations configured for a specific form.

Authentication & Scope

This endpoint requires a Personal Access Token with the manage-integrations ability.

Request

form
number
required
The ID of the form for which to list integrations.
GET /open/forms/{form}/integrations HTTP/1.1
Host: api.opnform.com
Authorization: Bearer <token>

Response

200 OK – Returns an array of integration objects.
[
  {
    "id": 42,
    "form_id": 123,
    "integration_id": "webhook",
    "status": "active",
    "data": {
      "webhook_url": "https://example.com/opnform-hook"
    }
  },
  {
    "id": 43,
    "form_id": 123,
    "integration_id": "webhook",
    "status": "inactive",
    "data": {
      "webhook_url": "https://old-endpoint.com/hook"
    }
  }
]
403 Forbidden – The token does not include the manage-integrations ability, or you don’t have permission to update this form.

Authorizations

Authorization
string
header
required

Personal Access Token

Path Parameters

form
number
required

The ID of the form.

Response

Successful

id
number

Unique identifier for the integration.

form_id
number

The ID of the associated form.

integration_id
string

Type of integration (currently only "webhook" is exposed via API).

Example:

"webhook"

status
enum<string>

Whether the integration is active.

Available options:
active,
inactive
data
object

Integration-specific configuration. For webhooks, contains webhook_url.

Example:
{
"webhook_url": "https://example.com/opnform-hook"
}