Batch

Retrieve batch

Changed on

Retrieve a batch of webhook journal entries starting from a specified offset. This endpoint allows you to fetch a defined number of entries, facilitating the processing of webhook data in manageable chunks.

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. This is an integer value with a minimum of 1.

offsetstring required

The starting point for fetching the batch of journal entries. This is a string value that indicates the offset position.

Query parameters

installPortalIdinteger

The ID of the portal installation. This is an integer value used to specify the portal context for the request.

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

  • 2027-03-beta6995629a4549Revision changes
    • info

      the endpoint scheme security oauth2 was removed from the API

  • 2027-03-beta0d8139833c65Revision 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}