Webhooks

Webhook management and events

Get all available webhook event types

get

Authorizations

Responses

200

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

application/json

eventTypestringRequired

Event type identifier

Example: extracted

descriptionstringRequired

Human-readable description of when this event is triggered

Example: Triggered after successful AI extraction of submission data

examplePayloadobjectRequired

Example payload structure for this event type

Example:

{"eventId":"123e4567-e89b-12d3-a456-426614174000","eventType":"extracted","timestamp":"2023-10-28T12:00:00.000Z","submissionId":"sub_789012","templateId":"tpl_345678"}

get/api/webhook/events

GET /api/webhook/events HTTP/1.1
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

Body

eventstring · enumRequiredPossible 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

idstringRequired

Unique identifier of the webhook subscriber

Example: 123e4567-e89b-12d3-a456-426614174000

eventstring · enumRequiredPossible values:

urlstringRequired

URL where webhook notifications will be sent

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

secretobjectRequired

Secret token used for HMAC signature generation

Example: 123e4567-e89b-12d3-a456-426614174000

createdAtstring · date-timeRequired

Timestamp when the webhook subscription was created

Example: 2023-01-01T12:00:00Z

updatedAtstring · date-timeRequired

Timestamp when the webhook subscription was last updated

Example: 2023-01-01T13:30:00Z

400

Bad request - URL and event are required

500

Internal server error

post/api/webhook/subscription

POST /api/webhook/subscription HTTP/1.1
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

Responses

200

List of webhook subscriptions

application/json

idstringRequired

Unique identifier of the webhook subscriber

Example: 123e4567-e89b-12d3-a456-426614174000

eventstring · enumRequiredPossible values:

urlstringRequired

URL where webhook notifications will be sent

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

secretobjectRequired

Secret token used for HMAC signature generation

Example: 123e4567-e89b-12d3-a456-426614174000

createdAtstring · date-timeRequired

Timestamp when the webhook subscription was created

Example: 2023-01-01T12:00:00Z

updatedAtstring · date-timeRequired

Timestamp when the webhook subscription was last updated

Example: 2023-01-01T13:30:00Z

500

Internal server error

get/api/webhook/subscriptions

GET /api/webhook/subscriptions HTTP/1.1
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

Path parameters

idstringRequired

Subscription ID

Responses

200

The webhook subscription details

application/json

idstringRequired

Unique identifier of the webhook subscriber

Example: 123e4567-e89b-12d3-a456-426614174000

eventstring · enumRequiredPossible values:

urlstringRequired

URL where webhook notifications will be sent

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

secretobjectRequired

Secret token used for HMAC signature generation

Example: 123e4567-e89b-12d3-a456-426614174000

createdAtstring · date-timeRequired

Timestamp when the webhook subscription was created

Example: 2023-01-01T12:00:00Z

updatedAtstring · date-timeRequired

Timestamp when the webhook subscription was last updated

Example: 2023-01-01T13:30:00Z

404

Subscription not found

500

Internal server error

get/api/webhook/subscription/{id}

GET /api/webhook/subscription/{id} HTTP/1.1
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

Path parameters

idstringRequired

Subscription ID

Body

eventstring · enumOptionalPossible values:

urlstringOptional

URL where webhook notifications will be sent

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

Responses

200

The updated webhook subscription

application/json

idstringRequired

Unique identifier of the webhook subscriber

Example: 123e4567-e89b-12d3-a456-426614174000

eventstring · enumRequiredPossible values:

urlstringRequired

URL where webhook notifications will be sent

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

secretobjectRequired

Secret token used for HMAC signature generation

Example: 123e4567-e89b-12d3-a456-426614174000

createdAtstring · date-timeRequired

Timestamp when the webhook subscription was created

Example: 2023-01-01T12:00:00Z

updatedAtstring · date-timeRequired

Timestamp when the webhook subscription was last updated

Example: 2023-01-01T13:30:00Z

404

Subscription not found

500

Internal server error

put/api/webhook/subscription/{id}

PUT /api/webhook/subscription/{id} HTTP/1.1
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

Path parameters

idstringRequired

Subscription ID

Responses

200

Subscription successfully deleted

application/json

successbooleanRequired

Indicates if the delete operation was successful

Example: true

404

Subscription not found

500

Internal server error

delete/api/webhook/subscription/{id}

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

{
  "success": true
}

Last updated 7 months ago

Was this helpful?