Batch

Retrieve Batch

Changed on

Retrieve the earliest batch of webhook journal entries up to the specified count. This endpoint is useful for fetching historical webhook data in batches, allowing you to process or analyze the earliest entries first.

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

Request

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

Path parameters

countinteger required

The maximum number of journal entries to retrieve in the batch. This must be an integer with a minimum value of 1.

Query parameters

installPortalIdinteger

The ID of the portal installation to filter the webhook journal entries by. This is an integer value.

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/2027-03-beta/batch/earliest/{count} removed and replaced with get-/webhooks-journal/journal/2027-03-beta/batch/earliest/{count}_/webhooks-journal/journal/2027-03-beta/batch/earliest/{count}