Zum Hauptinhalt springen
POST
/
webhooks
/
v3
/
{appId}
/
subscriptions
Ein Event-Abonnement erstellen
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"
}
Unterstützte Produkte
Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing HubProfessional
Sales HubSales HubProfessional
Service HubService HubProfessional
Content HubContent HubStarter

Authorizations

​
hapikey
string
query
required

Path Parameters

​
appId
integer
required

Die ID der App.

Body

application/json

New webhook settings for an app.

​
eventType
enum<string>
required

Typ von Events, die Sie beobachten möchten. Kann „create“, „delete“, „deletedForPrivacy“ oder „propertyChange“ sein.

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

Der interne Name der Eigenschaft, die auf Änderungen überwacht werden soll. Gilt nur, wenn „eventType“ auf „propertyChange“ festgelegt ist.

Example:

"email"

​
active
boolean

Gibt an, ob das Abonnement aktiv oder pausiert ist. Der Standardwert ist „false“ (falsch).

Example:

true

Response

successful operation

Complete details for an event subscription.

​
createdAt
string<date-time>
required

Wann dieses Abonnement erstellt wurde. Formatiert als Millisekunden ab der Unix-Epoche.

​
active
boolean
required

Legt fest, ob das Abonnement aktiv oder pausiert ist.

​
eventType
enum<string>
required

Typ von Events, die Sie beobachten möchten. Kann „create“, „delete“, „deletedForPrivacy“ oder „propertyChange“ sein.

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

Die eindeutige ID des Abonnements

​
objectTypeId
string

Die ID des Objekttyps, der dem Abonnement zugeordnet ist.

​
propertyName
string

Der interne Name der Eigenschaft, die auf Änderungen überwacht wird. Gilt nur, wenn „eventType“ auf „propertyChange“ festgelegt ist.

​
updatedAt
string<date-time>

Wann dieses Abonnement zuletzt aktualisiert wurde. Formatiert als Millisekunden ab der Unix-Epoche.

⌘I