Create an event subscription

Neues Event-Abonnement für die angegebene App erstellen.

POST /webhooks/2026-03/{appId}/subscriptions

Ein Event-Abonnement erstellen

cURL

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>"
}
'

201

{
  "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 für die App.

Body

application/json

active · boolean · erforderlich

Ein boolescher Wert, der angibt, ob das Abonnement aktiv ist.

eventType · enum<string> · erforderlich

Eine Zeichenfolge, die den Typ des zu abonnierenden Events darstellt. Gültige Werte umfassen verschiedene Eigenschaftsänderungen, Erstellungen, Löschungen, Zusammenführungen, Wiederherstellungen, Zuordnungsänderungen und Abschlüsse von Events.

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

Eine Zeichenfolge, die einen für Menschen lesbaren Namen für den Event-Typ bereitstellt.

objectTypeId · string

Eine Zeichenfolge, die die ID des Objekttyps darstellt, der dem Abonnement zugeordnet ist.

propertyName · string

Eine Zeichenfolge, die den spezifischen Eigenschaftsnamen angibt, der sich auf den Event-Typ bezieht, falls zutreffend.

Antwort

201

application/json

successful operation

active · boolean · erforderlich

Ein boolescher Wert, der angibt, ob das Abonnement derzeit aktiv ist.

createdAt · string<date-time> · erforderlich

Der Zeitpunkt (Datum und Uhrzeit), zu dem das Abonnement im ISO-8601-Format erstellt wurde.

eventType · enum<string> · erforderlich

Der Event-Typ, der das Abonnement auslöst. Gültige Werte umfassen verschiedene Eigenschaftsänderungen, Erstellungen, Löschungen, Zusammenführungen, Wiederherstellungen und Zuordnungsänderungen für verschiedene HubSpot-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 für das Abonnement. Es handelt sich um eine Ganzzahl im int64-Format.

eventTypeName · string

Der Name des Event-Typs für das Abonnement.

objectTypeId · string

Die ID für den Objekttyp, der mit dem Abonnement verknüpft ist. Es handelt sich um eine Zeichenfolge.

propertyName · string

Der Name der Eigenschaft, die gegebenenfalls dem Abonnement-Event zugeordnet ist.

updatedAt · string<date-time>

Der Zeitpunkt (Datum und Uhrzeit), zu dem das Abonnement im ISO-8601-Format zuletzt aktualisiert wurde.