Webhook events

List Webhook Events

Changed on

This operation retrieves a paginated list of all webhook events.

get/public/v1/webhook-events

Request

Query parameters

countinteger required

Specify how many event results to return.

pageinteger required

Specify which page of the dataset to return.

sincestring date-time

Return results where the event creation time is greater than or equal to this value.

tostring date-time

Return results where the event creation time is less than this value.

typeWebhookEventTriggerEnum[]

Returns results by the specified event types.

[
  "document_state_changed"
]
http_status_codeWebhookEventHttpStatusCodeGroupEnum[]

Returns results with the specified HTTP status codes.

[
  400
]
errorWebhookEventErrorEnum[]

Returns results with the following errors.

[
  "TIMEOUT_ERROR"
]

Response

Page of webhook events.

Example response

{
  "items": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "name": "My Subscription",
      "type": "document_state_changed",
      "http_status_code": 200,
      "error": "TIMEOUT_ERROR",
      "delivery_time": "2022-06-20T15:04:59.424730Z"
    }
  ]
}

Changes

    • warning

      added the new recipient_qes_verified enum value to the // response property for the response status

    • info

      added the enum value recipient_qes_verified to the property items/ of the query request parameter type