HUhubspot
Batch

Batch read

Changed on

Execute a batch read operation on the webhooks journal. This endpoint allows you to retrieve a batch of webhook journal entries by providing the necessary input data. It is useful for processing multiple records in a single request, streamlining data retrieval tasks.

post/webhooks-journal/journal-local/2026-03/batch/read

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/webhooks-journal/journal-local/2026-03/batch/read
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

Query parameters

installPortalIdinteger

The ID of the portal where the webhooks are installed. This parameter is optional and is used to specify the target portal for the operation.

Request body

inputsstring[] required

Strings to input.

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

  • f9c7181056c5Revision changes
    • info

      api operation id post-/webhooks-journal/journal-local/2026-03/batch/read_/webhooks-journal/journal-local/2026-03/batch/read removed and replaced with post-/webhooks-journal/journal-local/2026-03/batch/read

  • b0d8bc008db9Revision changes
    • info

      api operation id post-/webhooks-journal/journal-local/2026-03/batch/read_/webhooks-journal/journal-local/2026-03/batch/read removed and replaced with post-/webhooks-journal/journal-local/2026-03/batch/read

Some revisions have not been checked yet.