v29

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

Batch

Fetch Earliest Batch

Retrieve the earliest batch of webhook journal entries for a specified count. This endpoint is useful for accessing historical webhook data in batches, allowing you to process or analyze older entries. The number of entries retrieved is determined by the count parameter.

get/webhooks-journal/journal/2026-03/batch/earliest/{count}

Path parameters

countinteger required

The number of earliest journal entries to retrieve. This must be an integer with a minimum value of 1.

Query parameters

installPortalIdinteger

The ID of the portal installation. This is an integer value that specifies which portal's data to access.

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'.