Batch

Batch read

Changed on

Perform a batch read operation on the webhooks journal for the specified date. This endpoint allows you to retrieve multiple entries from the webhooks journal in a single request, which can be useful for processing large amounts of data efficiently.

post/webhooks-journal/journal/2027-03-beta/batch/read

Request

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

Query parameters

installPortalIdinteger

The ID of the portal where the webhooks are installed. This is an integer value.

Request body

inputsstring[] required

An array of strings to be processed. This property is required.

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 post-/webhooks-journal/journal/2027-03-beta/batch/read removed and replaced with post-/webhooks-journal/journal/2027-03-beta/batch/read_/webhooks-journal/journal/2027-03-beta/batch/read