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/2027-03-beta/batch/{offset}/next/{count}

Request

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

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

Changes

  • 2027-03-beta9a67db8e1ed3Revision changes
    • info

      the endpoint scheme security oauth2 was removed from the API

  • 2027-03-betaac6e731d1508Revision changes
    • info

      api operation id get-/webhooks-journal/journal-local/2027-03-beta/batch/{offset}/next/{count} removed and replaced with get-/webhooks-journal/journal-local/2027-03-beta/batch/{offset}/next/{count}_/webhooks-journal/journal-local/2027-03-beta/batch/{offset}/next/{count}