Zum Hauptinhalt springen
POST
/
webhooks
/
2026-03
/
{appId}
/
subscriptions
Ein Event-Abonnement erstellen
curl --request POST \
  --url https://api.hubapi.com/webhooks/2026-03/{appId}/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "eventType": "company.associationChange",
  "eventTypeName": "<string>",
  "objectTypeId": "<string>",
  "propertyName": "<string>"
}
'
{
  "active": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "eventType": "company.associationChange",
  "id": "<string>",
  "eventTypeName": "<string>",
  "objectTypeId": "<string>",
  "propertyName": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Supported products

Autorisierungen

Authorization
string
header
erforderlich

The access token received from the authorization server in the OAuth 2.0 flow.

Pfadparameter

appId
integer<int32>
erforderlich

Die ID der Ziel-App.

Body

application/json
active
boolean
erforderlich

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

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
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

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 (Format ISO 8601, 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, wann das Webhook-Abonnement zuletzt aktualisiert wurde (Format ISO 8601, z. B. 2020-02-29T12:30:00Z).

Last modified on April 13, 2026