HUhubspot
Batch

Fetch earliest batch

Changed on

Retrieve the earliest batch of webhook journal entries. This endpoint is useful for accessing the oldest available data in the webhook journal, allowing users to process or analyze historical webhook events. The number of entries to fetch is specified by the 'count' path parameter.

get/webhooks-journal/journal-local/2027-03-beta/batch/earliest/{count}

Request

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

Path parameters

countinteger required

The number of earliest webhook journal entries to retrieve. This is a required integer parameter with a minimum value of 1.

Query parameters

installPortalIdinteger

The ID of the portal installation to filter the webhook journal entries. This is an optional integer 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/earliest/{count} removed and replaced with get-/webhooks-journal/journal-local/2027-03-beta/batch/earliest/{count}_/webhooks-journal/journal-local/2027-03-beta/batch/earliest/{count}