Skip to main content
POST
Create an event subscription

Supported products

Authorizations

hapikey
string
query
required

Path Parameters

appId
integer<int32>
required

The unique identifier of the app for which the webhook subscription is being created.

Body

application/json
active
boolean
required

A boolean indicating whether the subscription is active.

eventType
enum<string>
required

A string representing the type of event to subscribe to. Valid values include various property changes, creations, deletions, merges, restorations, association changes, and event completions.

Available options:
company.associationChange,
company.creation,
company.deletion,
company.merge,
company.propertyChange,
company.restore,
contact.associationChange,
contact.creation,
contact.deletion,
contact.merge,
contact.privacyDeletion,
contact.propertyChange,
contact.restore,
conversation.creation,
conversation.deletion,
conversation.newMessage,
conversation.privacyDeletion,
conversation.propertyChange,
deal.associationChange,
deal.creation,
deal.deletion,
deal.merge,
deal.propertyChange,
deal.restore,
event.completed,
line_item.associationChange,
line_item.creation,
line_item.deletion,
line_item.merge,
line_item.propertyChange,
line_item.restore,
object.associationChange,
object.creation,
object.deletion,
object.merge,
object.propertyChange,
object.restore,
product.creation,
product.deletion,
product.merge,
product.propertyChange,
product.restore,
ticket.associationChange,
ticket.creation,
ticket.deletion,
ticket.merge,
ticket.propertyChange,
ticket.restore
eventTypeName
string

A string providing a human-readable name for the event type.

objectTypeId
string

A string representing the ID of the object type associated with the subscription.

propertyName
string

A string indicating the specific property name related to the event type, if applicable.

Response

successful operation

active
boolean
required

A boolean indicating whether the subscription is currently active.

createdAt
string<date-time>
required

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

eventType
enum<string>
required

The type of event that triggers the subscription. Valid values include various property changes, creations, deletions, merges, restores, and association changes for different HubSpot objects.

Available options:
company.associationChange,
company.creation,
company.deletion,
company.merge,
company.propertyChange,
company.restore,
contact.associationChange,
contact.creation,
contact.deletion,
contact.merge,
contact.privacyDeletion,
contact.propertyChange,
contact.restore,
conversation.creation,
conversation.deletion,
conversation.newMessage,
conversation.privacyDeletion,
conversation.propertyChange,
deal.associationChange,
deal.creation,
deal.deletion,
deal.merge,
deal.propertyChange,
deal.restore,
event.completed,
line_item.associationChange,
line_item.creation,
line_item.deletion,
line_item.merge,
line_item.propertyChange,
line_item.restore,
object.associationChange,
object.creation,
object.deletion,
object.merge,
object.propertyChange,
object.restore,
product.creation,
product.deletion,
product.merge,
product.propertyChange,
product.restore,
ticket.associationChange,
ticket.creation,
ticket.deletion,
ticket.merge,
ticket.propertyChange,
ticket.restore
id
string
required

The unique identifier for the subscription. It is an integer formatted as int64.

eventTypeName
string

The name of the event type for the subscription.

objectTypeId
string

The identifier for the object type associated with the subscription. It is a string.

propertyName
string

The name of the property associated with the subscription event, if applicable.

updatedAt
string<date-time>

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

Last modified on September 9, 2026