Zum Hauptinhalt springen
POST
/
webhooks
/
v3
/
{appId}
/
subscriptions
Ein Event-Abonnement erstellen
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": "2019-10-30T03:30:17.883Z",
  "eventType": "contact.propertyChange",
  "id": "12",
  "propertyName": "email",
  "updatedAt": "2019-11-30T03:30:17.883Z"
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Kostenlos
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Kostenlos

Autorisierungen

​
hapikey
string
query
erforderlich

Pfadparameter

​
appId
integer<int32>
erforderlich

Die ID der Ziel-App.

Body

application/json

Details about the new subscription.

Request to create a new webhook subscription for monitoring specific events. Each subscription defines which event type to listen for and whether to monitor all events of that type or specific property changes.

​
eventType
enum<string>
erforderlich

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

Verfügbare Optionen:
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
​
active
boolean

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

​
eventTypeName
string

Der Name des Events, das Sie beobachten möchten. Wird bei benutzerdefinierten Objekten verwendet, um benutzerdefinierte Event-Typen über die eventType-enum-Standardwerte hinaus zu spezifizieren.

​
objectTypeId
string

Die ID des Objekttyps für das Abonnement. Dies kann ein CRM-Standardobjekt (z. B. „Kontakt“, „Unternehmen“, „Deal“) oder eine benutzerdefinierte Objekt-ID für Abonnements benutzerdefinierter Objekte sein.

​
propertyName
string

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

Antwort

successful operation

Complete details for an event subscription.

​
active
boolean
erforderlich

Ob das Abonnement aktiv oder pausiert ist. Wenn „true“, sendet das Abonnement Webhook-Benachrichtigungen. Wenn „false“, ist das Abonnement pausiert und sendet keine Benachrichtigungen.

​
createdAt
string<date-time>
erforderlich

Der Zeitstempel, wann das Webhook-Abonnement erstellt wurde, im ISO 8601-Format (z. B. 2020-02-29T12:30:00Z).

​
eventType
enum<string>
erforderlich

Der Typ des Events, das Sie beobachten möchten. Akzeptierte Werte sind „contact.creation“, „contact.deletion“, „contact.propertyChange“ und ähnliche Event-Typen für andere CRM-Objekte und benutzerdefinierte Objekte.

Verfügbare Optionen:
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
erforderlich

Die eindeutige ID des Webhook-Abonnements.

​
eventTypeName
string

Der Name des Events, das Sie beobachten möchten. Wird bei benutzerdefinierten Objekten verwendet, um benutzerdefinierte Event-Typen über die eventType-enum-Standardwerte hinaus zu spezifizieren.

​
objectTypeId
string

Die ID des Objekttyps für das Abonnement. Dies kann ein CRM-Standardobjekt (z. B. „Kontakt“, „Unternehmen“, „Deal“) oder eine benutzerdefinierte Objekt-ID für Abonnements benutzerdefinierter Objekte sein.

​
propertyName
string

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

​
updatedAt
string<date-time>

Der Zeitstempel der letzten Aktualisierung des Webhook-Abonnements im ISO 8601-Format (z. B. 2020-02-29T12:30:00Z).

Last modified on March 24, 2026