HUhubspot
Basic

Retrieve subscription

Changed on

Retrieve details of a specific webhook subscription using its unique identifier. This endpoint is useful for obtaining information about a particular subscription's configuration and status within the HubSpot account.

get/webhooks-journal/subscriptions/2026-09/{subscriptionId}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/webhooks-journal/subscriptions/2026-09/{subscriptionId}
  • Auth
    none required

Path parameters

subscriptionIdinteger required

The unique identifier of the subscription to retrieve. It is an integer value.

Response

successful operation

actionOverridesobject

An object containing action overrides, where each key is an action and the value is an ActionOverrideRequest object.

actionsstring[] required

A list of actions that trigger the subscription. Possible values include 'CREATE', 'UPDATE', 'DELETE', 'MERGE', 'RESTORE', 'ASSOCIATION_ADDED', 'ASSOCIATION_REMOVED', 'SNAPSHOT', 'APP_INSTALL', 'APP_UNINSTALL', 'ADDED_TO_LIST', 'REMOVED_FROM_LIST', and 'GDPR_DELETE'.

appIdinteger required

The unique identifier for the app associated with the subscription. It is an integer formatted as int64.

associatedObjectTypeIdsstring[]

A list of associated object type IDs. Each ID is a string.

createdAtstring date-time required

The date and time when the subscription was created, in ISO 8601 format.

createdByinteger

The ID of the user who created the subscription. It is an integer formatted as int64.

deletedAtstring date-time

The date and time when the subscription was deleted, in ISO 8601 format, if applicable.

idinteger required

The unique identifier for the subscription. It is an integer formatted as int64.

listIdsinteger[]

A list of list IDs associated with the subscription. Each ID is an integer formatted as int64.

objectIdsinteger[]

A list of object IDs associated with the subscription. Each ID is an integer formatted as int64.

objectTypeIdstring required

The identifier for the object type associated with the subscription. It is a string.

portalIdinteger

The unique identifier for the portal associated with the subscription. It is an integer formatted as int64.

propertiesstring[]

A list of property names associated with the subscription. Each property is a string.

subscriptionType'APP_LIFECYCLE_EVENT' | 'ASSOCIATION' | 'EVENT' | 'GDPR_PRIVACY_DELETION' | 'LIST_MEMBERSHIP' | 'OBJECT' required

The type of subscription, which can be one of the following: 'OBJECT', 'ASSOCIATION', 'EVENT', 'APP_LIFECYCLE_EVENT', 'LIST_MEMBERSHIP', or 'GDPR_PRIVACY_DELETION'.

updatedAtstring date-time required

The date and time when the subscription was last updated, in ISO 8601 format.

Changes