Batch

Retrieve Batch

Changed on

Retrieve the earliest batch of webhook journal entries based on the specified count. This endpoint is useful for fetching a specific number of the earliest entries in the webhook journal for analysis or processing.

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 entries to retrieve from the webhook journal. Must be an integer with a minimum value of 1.

Query parameters

installPortalIdinteger

The ID of the portal where the webhooks are installed. 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-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}