> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
---
id: fb28e092-c47d-46cf-8b03-915adce68df8
---
# Read local journal entries in batch
> Perform a batch read operation on the webhooks journal. This endpoint allows you to read multiple entries from the journal in a single request. It requires a JSON request body specifying the inputs to be read. The response includes the results of the batch read operation, and may return multiple statuses if there are errors.
export const SupportedProducts = ({marketing, sales, service, cms, data, commerce, crm, marketingLevel, salesLevel, serviceLevel, cmsLevel, dataLevel, commerceLevel, crmLevel}) => {
const translations = {
description: "Requires one of the following products or higher.",
productNames: {
marketing: "Marketing Hub",
sales: "Sales Hub",
service: "Service Hub",
cms: "Content Hub",
data: "Data Hub",
commerce: "Revenue Hub",
crm: "Smart CRM"
},
tiers: {
free: "Free",
starter: "Starter",
professional: "Professional",
enterprise: "Enterprise"
}
};
const translateTier = tier => {
if (!tier) return '';
const lowerTier = tier.toLowerCase();
return translations.tiers[lowerTier] || tier;
};
const products = [{
name: marketing ? translations.productNames.marketing : '',
level: translateTier(marketingLevel),
icon: "https://mintlify-assets.b-cdn.net/Icons/marketing-bolt.svg",
alt: "Marketing Hub"
}, {
name: sales ? translations.productNames.sales : '',
level: translateTier(salesLevel),
icon: "https://mintlify-assets.b-cdn.net/Icons/sales-star.svg",
alt: "Sales Hub"
}, {
name: service ? translations.productNames.service : '',
level: translateTier(serviceLevel),
icon: "https://mintlify-assets.b-cdn.net/Icons/service-heart.svg",
alt: "Service Hub"
}, {
name: cms ? translations.productNames.cms : '',
level: translateTier(cmsLevel),
icon: "https://mintlify-assets.b-cdn.net/Icons/content-play.svg",
alt: "Content Hub"
}, {
name: data ? translations.productNames.data : '',
level: translateTier(dataLevel),
icon: "https://developers.hubspot.com/hubfs/Knowledge_Base_2023-24-25/subscription_key_icons/operations_icon.svg",
alt: "Data Hub"
}, {
name: commerce ? translations.productNames.commerce : '',
level: translateTier(commerceLevel),
icon: "https://developers.hubspot.com/hubfs/Knowledge_Base/subscription_key_icons/commerce_icon.svg",
alt: "Revenue Hub"
}, {
name: crm ? translations.productNames.crm : '',
level: translateTier(crmLevel),
icon: "https://developer.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/SmartCRM.svg",
alt: "Smart CRM"
}].filter(product => product.name && product.level);
if (products.length === 0) return null;
return
{translations.description}
{products.map((product, index) =>
{product.name} -{product.level}
)}
;
};
## OpenAPI
````yaml specs/2026-03/webhooks-webhooks-v2026-03.json POST /webhooks-journal/journal-local/2026-03/batch/read
openapi: 3.0.1
info:
title: Webhooks Webhooks
description: Basepom for all HubSpot Projects
version: 2026-03
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Advanced
- name: Basic
- name: Batch
paths:
/webhooks-journal/journal-local/2026-03/batch/read:
post:
tags:
- Batch
summary: Batch read
description: >-
Perform a batch read operation on the webhooks journal. This endpoint
allows you to read multiple entries from the journal in a single
request. It requires a JSON request body specifying the inputs to be
read. The response includes the results of the batch read operation, and
may return multiple statuses if there are errors.
operationId: >-
post-/webhooks-journal/journal-local/2026-03/batch/read_/webhooks-journal/journal-local/2026-03/batch/read
parameters:
- name: installPortalId
in: query
description: >-
The ID of the portal where the webhooks are installed. This
parameter is optional and is used to specify the target portal.
required: false
style: form
explode: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchInputString'
required: true
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/BatchResponseJournalFetchResponse'
'207':
description: multiple statuses
content:
application/json:
schema:
$ref: >-
#/components/schemas/BatchResponseJournalFetchResponseWithErrors
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- webhooks-journal-data-access
components:
schemas:
BatchInputString:
required:
- inputs
type: object
properties:
inputs:
type: array
description: An array of strings to be processed. This property is required.
items:
type: string
BatchResponseJournalFetchResponse:
required:
- completedAt
- results
- startedAt
- status
type: object
properties:
completedAt:
type: string
description: >-
The date and time when the batch operation was completed, in ISO
8601 format.
format: date-time
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs related to the batch
operation.
requestedAt:
type: string
description: >-
The date and time when the batch operation was requested, in ISO
8601 format.
format: date-time
results:
type: array
description: >-
An array of results from the batch operation, each represented as a
JournalFetchResponse object.
items:
$ref: '#/components/schemas/JournalFetchResponse'
startedAt:
type: string
description: >-
The date and time when the batch operation started, in ISO 8601
format.
format: date-time
status:
type: string
description: >-
The current status of the batch operation. Valid values include
'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.
enum:
- CANCELED
- COMPLETE
- PENDING
- PROCESSING
BatchResponseJournalFetchResponseWithErrors:
required:
- completedAt
- results
- startedAt
- status
type: object
properties:
completedAt:
type: string
description: >-
The date and time when the batch process was completed, in ISO 8601
format.
format: date-time
errors:
type: array
description: >-
An array of standard errors that occurred during the batch process,
providing details about each error.
items:
$ref: '#/components/schemas/StandardError'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs, providing additional context
or actions related to the batch process.
numErrors:
type: integer
description: The number of errors that occurred during the batch process.
format: int32
requestedAt:
type: string
description: >-
The date and time when the batch request was made, in ISO 8601
format.
format: date-time
results:
type: array
description: >-
An array of journal fetch responses, each representing a result from
the batch process.
items:
$ref: '#/components/schemas/JournalFetchResponse'
startedAt:
type: string
description: >-
The date and time when the batch process started, in ISO 8601
format.
format: date-time
status:
type: string
description: >-
The current status of the batch process. Valid values include
'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.
enum:
- CANCELED
- COMPLETE
- PENDING
- PROCESSING
JournalFetchResponse:
required:
- currentOffset
- expiresAt
- url
type: object
properties:
currentOffset:
type: string
description: >-
The unique identifier for the current offset of the journal entry,
formatted as a UUID.
format: uuid
expiresAt:
type: string
description: The date and time when the URL will expire, in ISO 8601 format.
format: date-time
url:
type: string
description: >-
The Pre-signed S3 URL where the journal entry can be accessed. It is
a string.
StandardError:
required:
- category
- context
- errors
- links
- message
- status
type: object
properties:
category:
type: string
description: A string indicating the category of the error.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: >-
An object containing additional context about the error condition,
with each property being an array of strings.
errors:
type: array
description: >-
An array of ErrorDetail objects providing further information about
the error.
items:
$ref: '#/components/schemas/ErrorDetail'
id:
type: string
description: A string that uniquely identifies the error instance.
links:
type: object
additionalProperties:
type: string
description: >-
An object mapping link names to associated URIs that contain
documentation about the error or recommended remediation steps.
message:
type: string
description: A string containing a human-readable message describing the error.
status:
type: string
description: A string representing the status of the error.
subCategory:
type: object
properties: {}
description: An object providing more specific categorization of the error.
description: Ye olde error
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: The error category.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: >-
Context about the error condition, represented as an object with
additional properties.
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request, formatted as a UUID. This
should be included with any error reports or support tickets.
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: >-
An array providing further information about the error, with each
item being an ErrorDetail object.
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps, represented as an
object with string properties.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate. It is a string.
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error, represented as a string.
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: >-
The status code associated with the error detail. This string
provides a standardized error code for reference.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: >-
Context about the error condition, represented as an object where
each key is a context name and the value is an array of strings
providing further details.
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: >-
The name of the field or parameter in which the error was found. It
is a string that helps identify the source of the error.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate. This is a required field.
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error. This string helps further classify the error.
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
developers-read: ''
developers-write: ''
private-apps-read: ''
private-apps-write: ''
webhooks-journal-data-access: ''
webhooks-journal-snapshot-management: ''
webhooks-journal-subscription-management: ''
webhooks-journal-subscription-read: ''
````
{product.name} -
{product.level}
)}