Skip to main content
GET
/
open
/
forms
/
{form}
/
integrations
/
{integrationid}
/
events
curl -X GET 'https://api.opnform.com/open/forms/123/integrations/42/events' \
  -H 'Authorization: Bearer YOUR_PAT'
[
  {
    "id": 1001,
    "integration_id": 42,
    "event": "submission.created",
    "status": "success",
    "response_code": 200,
    "created_at": "2024-01-15T10:30:00Z"
  },
  {
    "id": 1000,
    "integration_id": 42,
    "event": "submission.created",
    "status": "failed",
    "response_code": 500,
    "error_message": "Internal Server Error",
    "created_at": "2024-01-15T10:25:00Z"
  },
  {
    "id": 999,
    "integration_id": 42,
    "event": "submission.created",
    "status": "success",
    "response_code": 200,
    "created_at": "2024-01-15T10:20:00Z"
  }
]

List Webhook Events

Retrieve a paginated list of webhook dispatch events for a specific integration.

Authentication & Scope

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

Request

form
number
required
The ID of the form containing the webhook.
integrationid
number
required
The ID of the webhook integration for which to list events.
GET /open/forms/{form}/integrations/{integrationid}/events HTTP/1.1
Host: api.opnform.com
Authorization: Bearer <token>
curl -X GET 'https://api.opnform.com/open/forms/123/integrations/42/events' \
  -H 'Authorization: Bearer YOUR_PAT'

Response

200 OK – Returns an array of event objects, ordered by creation date (newest first).
[
  {
    "id": 1001,
    "integration_id": 42,
    "event": "submission.created",
    "status": "success",
    "response_code": 200,
    "created_at": "2024-01-15T10:30:00Z"
  },
  {
    "id": 1000,
    "integration_id": 42,
    "event": "submission.created",
    "status": "failed",
    "response_code": 500,
    "error_message": "Internal Server Error",
    "created_at": "2024-01-15T10:25:00Z"
  },
  {
    "id": 999,
    "integration_id": 42,
    "event": "submission.created",
    "status": "success",
    "response_code": 200,
    "created_at": "2024-01-15T10:20:00Z"
  }
]

Event object properties

id
number
Unique identifier for the event record.
integration_id
number
The ID of the webhook integration that generated this event.
event
string
The type of event. Currently: "submission.created".
status
string
Result of the webhook dispatch. Values: "success", "failed", "timeout".
response_code
number | null
HTTP status code returned by your webhook endpoint (if applicable).
error_message
string | null
Error details if the webhook dispatch failed.
created_at
string
ISO 8601 timestamp of when the webhook was dispatched.

Error responses

403 Forbidden – The token does not have manage-integrations ability or insufficient form permissions. 404 Not Found – Form or integration not found.

Use cases

  • Debugging: Check recent events to verify your webhook is receiving requests.
  • Monitoring: Track success/failure rates to identify reliability issues.
  • Audit trail: Review when submissions were sent to your endpoint.

Authorizations

Authorization
string
header
required

Personal Access Token

Path Parameters

form
number
required

The ID of the form.

integrationid
number
required

The ID of the integration.

Response

Successful

id
number

Unique identifier for the event record.

integration_id
number

The ID of the webhook integration that generated this event.

event
string

The type of event.

Example:

"submission.created"

status
enum<string>

Result of the webhook dispatch.

Available options:
success,
failed,
timeout
response_code
number | null

HTTP status code returned by the webhook endpoint.

error_message
string | null

Error details if the webhook dispatch failed.

created_at
string<date-time>

ISO 8601 timestamp of when the webhook was dispatched.