v29

OpenAPI 3.0.1raw.githubusercontent.com2026-06-030080.0 KB

Batch

Fetch Batch

Retrieve a batch of webhook journal entries starting from a specified offset. This endpoint is useful for paginating through large sets of webhook data. The number of entries returned is determined by the 'count' parameter.

get/webhooks-journal/journal-local/2026-03/batch/{offset}/next/{count}

Path parameters

countinteger required

The number of journal entries to retrieve in this batch. Must be an integer with a minimum value of 1.

offsetstring required

The starting point for the batch retrieval, specified as a string.

Query parameters

installPortalIdinteger

The ID of the portal where the webhooks are installed. This is an optional parameter.

Response

successful operation

completedAtstring date-time required

The date and time when the batch operation was completed, in ISO 8601 format.

linksobject

A map of link names to associated URIs, providing additional resources or information related to the batch operation.

requestedAtstring date-time

The date and time when the batch operation was requested, in ISO 8601 format.

startedAtstring date-time required

The date and time when the batch operation started, in ISO 8601 format.

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.