Batch

Fetch Batch Entries

Changed on

Retrieve a batch of webhook journal entries starting from a specified offset. This endpoint allows you to fetch a specified number of entries, making it useful for paginating through large sets of webhook journal data.

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

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/webhooks-journal/journal/2026-09/batch/{offset}/next/{count}
  • Auth
    none required

Path parameters

countinteger required

The number of entries to retrieve in the batch. This is an integer and must be at least 1.

offsetstring required

The starting point in the journal from which entries will be fetched. This is a string value.

Query parameters

installPortalIdinteger

An optional integer parameter to specify the portal ID for which the webhook journal entries should be retrieved.

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

Changes