Webhooks

Webhook management and events

Get all available webhook event types

get

Authorizations

access-token

Responses

200

Returns list of all webhook event types with descriptions and example payloads

application/json

get

/api/webhook/events

HTTPcURLJavaScriptPython

GET /api/webhook/events HTTP/1.1
Host: 
Accept: */*

200

Returns list of all webhook event types with descriptions and example payloads

[
  {
    "eventType": "extracted",
    "description": "Triggered after successful AI extraction of submission data",
    "examplePayload": {
      "eventId": "123e4567-e89b-12d3-a456-426614174000",
      "eventType": "extracted",
      "timestamp": "2023-10-28T12:00:00.000Z",
      "submissionId": "sub_789012",
      "templateId": "tpl_345678"
    }
  }
]

Create webhook subscription

post

Authorizations

access-token

Body

application/json

eventall ofRequired

Event type that triggers the webhook

Example: extracted

string · enumOptionalPossible values:

urlstringRequired

URL where webhook notifications will be sent

Example: https://example.com/webhook-endpoint

Responses

201

The webhook subscription has been created

application/json

400

Bad request - URL and event are required

500

Internal server error

post

/api/webhook/subscription

HTTPcURLJavaScriptPython

POST /api/webhook/subscription HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "event": "extracted",
  "url": "https://example.com/webhook-endpoint"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "event": "extracted",
  "url": "https://example.com/webhook-endpoint",
  "secret": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2023-01-01T12:00:00Z",
  "updatedAt": "2023-01-01T13:30:00Z"
}

Get all webhook subscriptions

get

Authorizations

access-token

Responses

200

List of webhook subscriptions

application/json

500

Internal server error

get

/api/webhook/subscriptions

HTTPcURLJavaScriptPython

GET /api/webhook/subscriptions HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "event": "extracted",
    "url": "https://example.com/webhook-endpoint",
    "secret": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2023-01-01T12:00:00Z",
    "updatedAt": "2023-01-01T13:30:00Z"
  }
]

Get webhook subscription by ID

get

Authorizations

access-token

Path parameters

idstringRequired

Subscription ID

Responses

200

The webhook subscription details

application/json

404

Subscription not found

500

Internal server error

get

/api/webhook/subscription/{id}

HTTPcURLJavaScriptPython

GET /api/webhook/subscription/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "event": "extracted",
  "url": "https://example.com/webhook-endpoint",
  "secret": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2023-01-01T12:00:00Z",
  "updatedAt": "2023-01-01T13:30:00Z"
}

Update webhook subscription

put

Authorizations

access-token

Path parameters

idstringRequired

Subscription ID

Body

application/json

eventall ofOptional

Event type that triggers the webhook

Example: extracted

string · enumOptionalPossible values:

urlstringOptional

URL where webhook notifications will be sent

Example: https://example.com/webhook-endpoint

Responses

200

The updated webhook subscription

application/json

404

Subscription not found

500

Internal server error

put

/api/webhook/subscription/{id}

HTTPcURLJavaScriptPython

PUT /api/webhook/subscription/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "event": "extracted",
  "url": "https://example.com/webhook-endpoint"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "event": "extracted",
  "url": "https://example.com/webhook-endpoint",
  "secret": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2023-01-01T12:00:00Z",
  "updatedAt": "2023-01-01T13:30:00Z"
}

Delete webhook subscription

delete

Authorizations

access-token

Path parameters

idstringRequired

Subscription ID

Responses

200

Subscription successfully deleted

application/json

404

Subscription not found

500

Internal server error

delete

/api/webhook/subscription/{id}

HTTPcURLJavaScriptPython

DELETE /api/webhook/subscription/{id} HTTP/1.1
Host: 
Accept: */*

{
  "success": true
}