Create or update a subscription
Create a new webhook journal subscription for the specified portal. This endpoint allows you to define the actions and object types that the subscription will monitor. It requires a request body with the subscription details.
Supported products
Supported products
Body
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
An array of strings specifying the actions that trigger the subscription. Valid actions include 'CREATE', 'UPDATE', 'DELETE', 'MERGE', 'RESTORE', 'ASSOCIATION_ADDED', 'ASSOCIATION_REMOVED', 'SNAPSHOT', 'APP_INSTALL', 'APP_UNINSTALL', 'ADDED_TO_LIST', 'REMOVED_FROM_LIST', and 'GDPR_DELETE'.
CREATE, UPDATE, DELETE, MERGE, RESTORE, ASSOCIATION_ADDED, ASSOCIATION_REMOVED, SNAPSHOT, APP_INSTALL, APP_UNINSTALL, ADDED_TO_LIST, REMOVED_FROM_LIST, GDPR_DELETE An array of integers specifying the unique identifiers of the objects involved in the subscription.
A string representing the unique identifier of the object type for which the subscription is being created or updated.
An integer representing the unique identifier of the HubSpot portal.
An array of strings listing the properties of the objects that are relevant to the subscription.
A string indicating the type of subscription, which is always 'OBJECT' for this request.
OBJECT Response
successful operation
An array of actions associated with the subscription. Valid actions include 'CREATE', 'UPDATE', 'DELETE', 'MERGE', 'RESTORE', 'ASSOCIATION_ADDED', 'ASSOCIATION_REMOVED', 'SNAPSHOT', 'APP_INSTALL', 'APP_UNINSTALL', 'ADDED_TO_LIST', 'REMOVED_FROM_LIST', and 'GDPR_DELETE'.
CREATE, UPDATE, DELETE, MERGE, RESTORE, ASSOCIATION_ADDED, ASSOCIATION_REMOVED, SNAPSHOT, APP_INSTALL, APP_UNINSTALL, ADDED_TO_LIST, REMOVED_FROM_LIST, GDPR_DELETE The unique identifier for the app associated with the subscription, represented as an integer.
The date and time when the subscription was created, in ISO 8601 format.
The unique identifier for the subscription, represented as an integer.
The identifier for the type of object associated with the subscription, represented as a string.
The type of subscription, indicating the nature of events it pertains to. Valid values include 'OBJECT', 'ASSOCIATION', 'EVENT', 'APP_LIFECYCLE_EVENT', 'LIST_MEMBERSHIP', and 'GDPR_PRIVACY_DELETION'.
APP_LIFECYCLE_EVENT, ASSOCIATION, EVENT, GDPR_PRIVACY_DELETION, LIST_MEMBERSHIP, OBJECT The date and time when the subscription was last updated, in ISO 8601 format.
An object containing overrides for actions, where each key is an action and the value is an ActionOverrideRequest object.
An array of strings representing the IDs of associated object types.
The unique identifier of the user who created the subscription, represented as an integer.
The date and time when the subscription was deleted, in ISO 8601 format, if applicable.
An array of integers representing the IDs of lists associated with the subscription.
An array of integers representing the IDs of objects associated with the subscription.
The unique identifier for the portal associated with the subscription, represented as an integer.
An array of strings representing the properties associated with the subscription.