An array containing all active and paused event subscriptions configured for the app. Each item in the array is a SubscriptionResponse object.
activebooleanrequired
Whether the subscription is active or paused. If true, the subscription will send webhook notifications. If false, the subscription is paused and will not send notifications.
createdAtstring (date-time)required
The timestamp when the webhook subscription was created, in ISO 8601 format (e.g., 2020-02-29T12:30:00Z).
eventTypestringrequired
The type of event to listen for. Accepted values include contact.creation, contact.deletion, contact.propertyChange, and similar event types for other CRM objects and custom objects.
One ofcompany.associationChangecompany.creationcompany.deletioncompany.mergecompany.propertyChangecompany.restorecontact.associationChangecontact.creationcontact.deletioncontact.mergecontact.privacyDeletioncontact.propertyChangecontact.restoreconversation.creationconversation.deletionconversation.newMessageconversation.privacyDeletionconversation.propertyChangedeal.associationChangedeal.creationdeal.deletiondeal.mergedeal.propertyChangedeal.restoreevent.completedline_item.associationChangeline_item.creationline_item.deletionline_item.mergeline_item.propertyChangeline_item.restoreobject.associationChangeobject.creationobject.deletionobject.mergeobject.propertyChangeobject.restoreproduct.creationproduct.deletionproduct.merge
eventTypeNamestring
The name of the event to listen for. This is used with custom objects to specify custom event types beyond the standard eventType enum values.
idstringrequired
The unique ID of the webhook subscription.
objectTypeIdstring
The ID of the object type for the subscription. This can be a standard CRM object (e.g., 'contact', 'company', 'deal') or a custom object ID for custom object subscriptions.
propertyNamestring
The internal name of the property to monitor for changes. Only applies when eventType is propertyChange.
updatedAtstring (date-time)
The timestamp when the webhook subscription was last updated, in ISO 8601 format (e.g., 2020-02-29T12:30:00Z).