Create or update a subscription
Create a new webhook subscription for the specified portal in the HubSpot account. This endpoint allows you to define the subscription details, including the types of events you want to subscribe to. The request body must include the necessary subscription information as defined by the SubscriptionUpsertRequest schema.
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.
Supported products
Supported products
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
CREATE, UPDATE, DELETE, MERGE, RESTORE, ASSOCIATION_ADDED, ASSOCIATION_REMOVED, SNAPSHOT, APP_INSTALL, APP_UNINSTALL, ADDED_TO_LIST, REMOVED_FROM_LIST, GDPR_DELETE OBJECT Response
successful operation
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'.
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. It is an integer formatted as int64.
The date and time when the subscription was created, in ISO 8601 format.
The unique identifier for the subscription. It is an integer formatted as int64.
The identifier for the object type associated with the subscription. It is a string.
The type of subscription, which can be one of the following: 'OBJECT', 'ASSOCIATION', 'EVENT', 'APP_LIFECYCLE_EVENT', 'LIST_MEMBERSHIP', or '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 action overrides, where each key is an action and the value is an ActionOverrideRequest object.
A list of associated object type IDs. Each ID is a string.
The ID of the user who created the subscription. It is an integer formatted as int64.
The date and time when the subscription was deleted, in ISO 8601 format, if applicable.
A list of list IDs associated with the subscription. Each ID is an integer formatted as int64.
A list of object IDs associated with the subscription. Each ID is an integer formatted as int64.
The unique identifier for the portal associated with the subscription. It is an integer formatted as int64.
A list of property names associated with the subscription. Each property is a string.