HUhubspot
Batch

Fetch Batch

Changed on

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-09/batch/{offset}/next/{count}

Request

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

Path parameters

countinteger required

An integer specifying the number of journal entries to retrieve. Must be at least 1.

offsetstring required

A string representing the starting point for fetching the batch of journal entries.

Query parameters

installPortalIdinteger

An integer representing the ID of the portal installation to filter the webhook journal entries.

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

Changes