v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB

Basic

Create Subscription

Create a new subscription in the Webhooks Journal for the specified version. This endpoint allows you to define the subscription details by providing the necessary information in the request body. It supports various types of subscriptions, including object, association, event, app lifecycle event, list membership, and GDPR privacy deletion. Ensure that all required fields are included in the request to successfully create a subscription.

post/webhooks-journal/subscriptions/2026-03

Request body

Response

successful operation

actionOverridesobject

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

actionsstring[] required

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'.

appIdinteger required

The unique identifier for the app associated with the subscription, represented as an integer.

associatedObjectTypeIdsstring[]

An array of strings representing the IDs of associated object types.

createdAtstring date-time required

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

createdByinteger

The unique identifier of the user who created the subscription, represented as an integer.

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, represented as an integer.

listIdsinteger[]

An array of integers representing the IDs of lists associated with the subscription.

objectIdsinteger[]

An array of integers representing the IDs of objects associated with the subscription.

objectTypeIdstring required

The identifier for the type of object associated with the subscription, represented as a string.

portalIdinteger

The unique identifier for the portal associated with the subscription, represented as an integer.

propertiesstring[]

An array of strings representing the properties associated with the subscription.

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'.

updatedAtstring date-time required

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