Skip to main content
POST
/
webhooks
/
v3
/
{appId}
/
subscriptions
Create an event subscription
curl --request POST \
  --url 'https://api.hubapi.com/webhooks/v3/{appId}/subscriptions?hapikey=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "eventType": "contact.propertyChange",
  "propertyName": "email"
}
'
{
  "active": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "eventType": "company.associationChange",
  "id": "<string>",
  "objectTypeId": "<string>",
  "propertyName": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Supported products

Requires one of the following products or higher.
Marketing HubMarketing Hub -Free
Sales HubSales Hub -Free
Service HubService Hub -Free
Content HubContent Hub -Free
Data HubData Hub -Free

Authorizations

​
hapikey
string
query
required

Path Parameters

​
appId
integer<int32>
required

The ID of the app.

Body

application/json

New webhook settings for an app.

​
eventType
enum<string>
required

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

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,
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
​
active
boolean

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

​
objectTypeId
string
​
propertyName
string

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

Response

successful operation

Complete details for an event subscription.

​
active
boolean
required

Determines if the subscription is active or paused.

​
createdAt
string<date-time>
required

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

​
eventType
enum<string>
required

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

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,
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 ID of the subscription.

​
objectTypeId
string

The identifier of the object type associated with the subscription.

​
propertyName
string

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

​
updatedAt
string<date-time>

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

Last modified on December 16, 2025