POST
/
webhooks
/
v3
/
{appId}
/
subscriptions
Créer un abonnement à un événement
curl --request POST \
  --url https://api.hubapi.com/webhooks/v3/{appId}/subscriptions \
  --header 'Content-Type: application/json' \
  --data '{
  "active": true,
  "eventType": "contact.propertyChange",
  "propertyName": "email"
}'
{
  "createdAt": "2023-11-07T05:31:56Z",
  "objectTypeId": "<string>",
  "propertyName": "<string>",
  "active": true,
  "eventType": "contact.propertyChange",
  "id": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}
Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubPro
Sales HubSales HubPro
Service HubService HubPro
Content HubContent HubStarter

Authorizations

​
hapikey
string
query
required

Path Parameters

​
appId
integer
required

L'ID de l'application.

Body

application/json

New webhook settings for an app.

​
eventType
enum<string>
required

Type d'événement auxquels être attentifs : « create » « delete » « deletedForPrivacy » « propertyChange »

Available options:
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,
contact.merge,
company.merge,
deal.merge,
ticket.merge,
product.merge,
line_item.merge,
contact.restore,
company.restore,
deal.restore,
ticket.restore,
product.restore,
line_item.restore,
contact.associationChange,
company.associationChange,
deal.associationChange,
ticket.associationChange,
line_item.associationChange,
object.propertyChange,
object.creation,
object.deletion,
object.merge,
object.restore,
object.associationChange
Example:

"contact.propertyChange"

​
objectTypeId
string
​
propertyName
string

Le nom interne de la propriété à surveiller pour les changements. S'applique uniquement lorsque « eventType » est « propertyChange ».

Example:

"email"

​
active
boolean

Détermine si l'abonnement est actif ou en pause. Par défaut, il est faux.

Example:

true

Response

successful operation

Complete details for an event subscription.

​
createdAt
string<date-time>
required

Date de création de cet abonnement. Formaté en millisecondes depuis l'époque Unix.

​
active
boolean
required

Détermine si l'abonnement est actif ou en pause.

​
eventType
enum<string>
required

Type d'événement auxquels être attentifs : « create » « delete » « deletedForPrivacy » « propertyChange »

Available options:
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,
contact.merge,
company.merge,
deal.merge,
ticket.merge,
product.merge,
line_item.merge,
contact.restore,
company.restore,
deal.restore,
ticket.restore,
product.restore,
line_item.restore,
contact.associationChange,
company.associationChange,
deal.associationChange,
ticket.associationChange,
line_item.associationChange,
object.propertyChange,
object.creation,
object.deletion,
object.merge,
object.restore,
object.associationChange
​
id
string
required

L'identifiant unique de l'abonnement.

​
objectTypeId
string

L'identifiant du type d'objet associé à l'abonnement.

​
propertyName
string

Le nom interne de la propriété surveillée pour les changements. S'applique uniquement lorsque « eventType » est « propertyChange ».

​
updatedAt
string<date-time>

Quand cet abonnement a été mis à jour pour la dernière fois. Formaté en millisecondes depuis l'époque Unix.