v1

latestOpenAPI 3.0.32026-07-24198357534.7 KB

Integration

This endpoint provides a list of Webhooks

Retrieves the collection of WebhookConfiguration resources.

get/webhooks

Query parameters

pageinteger

The collection page number

limitinteger

The number of items per page

paginationboolean

Enable or disable pagination

order[name]'asc' | 'desc'

order[dateModified]'asc' | 'desc'

namestring

urlstring

url[]string[]

activeboolean

Response

WebhookConfiguration collection

idstring uuid

namestring

activeboolean

urlstring uri

eventsWebhookEvent[]

parametersstring[]

dateCreatedstring date-time

dateModifiedstring date-time

Example response

[
  {
    "id": "c7ad508b-882d-4874-a00c-4b0eecb66e3d",
    "url": "https://example.com/hook",
    "events": [
      "document.create",
      "document.update"
    ],
    "headers": {
      "Authorization": "Header value",
      "Content-Type": "Header value"
    }
  }
]