Sign in

v1

latestOpenAPI 3.0.12026-07-1491517.1 KB
Subscriptions

post/webhooks/v3/{appId}/subscriptions

Path parameters

appIdinteger required

Request body

activeboolean

Determines if the subscription is active or paused. Defaults to false.

eventType'contact.propertyChange' | 'company.propertyChange' | 'deal.propertyChange' | 'ticket.propertyChange' | 'product.propertyChange' | 'line_item.propertyChange' | 'contact.creation' | 'contact.deletion' | 'contact.privacyDeletion' | 'company.creation' | 'company.deletion' | 'deal.creation' | 'deal.deletion' | 'ticket.creation' | 'ticket.deletion' | 'product.creation' | 'product.deletion' | 'line_item.creation' | 'line_item.deletion' | 'conversation.creation' | 'conversation.deletion' | 'conversation.newMessage' | 'conversation.privacyDeletion' | 'conversation.propertyChange' required

Type of event to listen for. Can be one of create, delete, deletedForPrivacy, or propertyChange.

propertyNamestring

The internal name of the property to monitor for changes. Only applies when eventType is propertyChange.

Example request

{
  "active": true,
  "eventType": "contact.propertyChange",
  "propertyName": "email"
}

Response

successful operation

activeboolean required

Determines if the subscription is active or paused.

createdAtstring date-time required

When this subscription was created. Formatted as milliseconds from the Unix epoch.

eventType'contact.propertyChange' | 'company.propertyChange' | 'deal.propertyChange' | 'ticket.propertyChange' | 'product.propertyChange' | 'line_item.propertyChange' | 'contact.creation' | 'contact.deletion' | 'contact.privacyDeletion' | 'company.creation' | 'company.deletion' | 'deal.creation' | 'deal.deletion' | 'ticket.creation' | 'ticket.deletion' | 'product.creation' | 'product.deletion' | 'line_item.creation' | 'line_item.deletion' | 'conversation.creation' | 'conversation.deletion' | 'conversation.newMessage' | 'conversation.privacyDeletion' | 'conversation.propertyChange' required

Type of event to listen for. Can be one of create, delete, deletedForPrivacy, or propertyChange.

idstring required

The unique ID of the subscription.

propertyNamestring

The internal name of the property being monitored for changes. Only applies when eventType is propertyChange.

updatedAtstring date-time

When this subscription was last updated. Formatted as milliseconds from the Unix epoch.