Zum Hauptinhalt springen
Letzte Änderung: 8. Oktober 2025
Um eine Anzahl von Webhook-Abonnements für eine App auf der neuen Entwicklerplattform zu definieren, fügen Sie dem Projekt ein webhooks-Verzeichnis zusammen mit einer *-hsmeta.json-Konfigurationsdatei bei.

​
Verzeichnisstruktur

├──src
│   ├── app/
│   │   └── app-hsmeta.json
│   │   └── ...
│   │   └── webhooks/
│   │     └── webhooks-hsmeta.json
└──

​
Webhook-Berichtskonfiguration

Nachfolgend finden Sie die verfügbaren Konfigurationsoptionen für die *-hsmeta.json-Datei. 
{
  "uid": "webhooks",
  "type": "webhooks",
  "config": {
    "settings": {
      "targetUrl": "https://example.com/webhook",
      "maxConcurrentRequests": 10
    },
    "subscriptions": {
      "crmObjects": [
        {
          "subscriptionType": "object.creation",
          "objectType": "contact",
          "active": true
        }
      ],
      "legacyCrmObjects": [
        {
          "subscriptionType": "contact.propertyChange",
          "propertyName": "lastname",
          "active": true
        },
        {
          "subscriptionType": "contact.deletion",
          "active": true
        }
      ],
      "hubEvents": [
        {
          "subscriptionType": "contact.privacyDeletion",
          "active": true
        }
      ]
    }
  }
}

Mit * markierte Felder sind Pflichtfelder.

FeldTypBeschreibung
uid*ZeichenfolgeEine interne eindeutige ID für die Webhook-Komponente.
type*ZeichenfolgeDer Typ der Komponente, die in diesem Fall webhooks sein sollte.
settings*ObjektEin Objekt, das zwei Felder angibt: targetUrl ist die öffentlich verfügbare URL für HubSpot-Aufrufe, an die Event-Payloads geliefert werden, und maxConcurrentRequests stellt den oberen Schwellenwert von HTTP-Anfragen dar, die HubSpot in einem bestimmten Zeitraum vornimmt.
subscriptions*ObjektEin Objekt, das die Abonnementtypen angibt, die Ihre App abonnieren wird.
crmObjectsArray

Ein Array mit Definitionen für Event-Abonnements. Dies ist das aufzunehmende Standard-Array, das für alle Events im neuen Format (object.*) verwendet werden sollte.

Klassische Webhook-Abonnementtypen sollten aber je nach Event in legacyCrmObjects- und hubEvents -Arrays enthalten sein.

legacyCrmObjectsArrayEin Arraymit klassischen Abonnementtypen wie contact.creation und deal.deletion.
hubEventsArrayEin Array mit den klassischen Abonnementtypen contact.privacyDeletion und conversation.*
Für jedes subscription Objekt können die folgenden Felder angegeben werden, je nachdem, welcher Abonnementdefinitionstyp abonniert wird (d. h. crmObjects, legacyCrmObjectsbzw. hubEvents) oder abhängig davon, ob Sie eine bestimmte Eigenschaftsänderung abonnieren (z  B contact.propertyChange).
FeldTypBeschreibung
subscriptionTypeZeichenfolgeDer Typ des abonnierten Events.
objectTypeZeichenfolgeFür Abonnements, die innerhalb des crmObjects-Arrays angegeben sind, gibt dies das CRM-Objekt an, das Ihre App abonniert.
propertyNameZeichenfolgeBei Abonnements von Eigenschaftenänderungen gibt dies an, durch welche Eigenschaft das Webhook-Event ausgelöst wird.
activeBoolescher WertGibt an, ob Webhook-Events für dieses Abonnement ausgelöst werden.