Zum Hauptinhalt springen
Für diese Funktion ist allerdings die Genehmigung von HubSpot erforderlich. Wenn Sie gerne Zugriff auf App-Objekte beantragen oder mehr über die Funktionalität erfahren möchten, senden Sie bitte dieses Formular ein.
Im Folgenden finden Sie Referenzinformationen für App-Funktionen der Entwicklerplattform mit App-Objekten, einschließlich Konfigurationsdateidefinitionen, Details zu Bereichen und mehr.

Projektstruktur

  • Alle App-Funktionen und -Komponenten müssen innerhalb des in der hsproject.json-Konfigurationsdatei angegebenen src-Verzeichnisses gespeichert werden.
  • Alle App-Funktionen und -Komponenten müssen innerhalb des app/-Verzeichnisses gespeichert werden.
  • App-Objektzuordnungen werden innerhalb des app-object-associations/-Verzeichnisses definiert.
  • Webhook-Abonnements werden innerhalb des webhooks/-Verzeichnisses definiert.
  • Benutzerdefinierte Workflow-Aktionen werden innerhalb des workflow-actions/-Verzeichnisses definiert.
  • Alle Kartenfunktionen müssen im cards/-Verzeichnisses gespeichert werden.
  • Für alle alle Komponenten- und Feature-Instanzen ist anzugeben, dass sie *-hsmeta.json-Dateien verwenden. Stellen Sie dem Dateinamen etwas Aussagekräftiges voran (z. B my-app-hsmeta.json). Diese Dateien müssen sich auf der Stammebene ihres jeweiligen Ordners befinden (z. B. app/my-app-hsmeta.json, cards/my-card-hsmeta.json).
Die folgende Beispielverzeichnisstruktur zeigt alle verfügbaren Funktionen.

Beispiel auf GitHub anzeigen

App-Objekte

Um ein App-Objekt zu erstellen, fügen Sie ein app-objects-Komponentenverzeichnis zusammen mit einer Konfigurationsdatei in das Projekt ein.
Nachfolgend finden Sie die Konfigurationsoptionen für *-object-hsmeta.json.

Beispiel auf GitHub anzeigen

Mit * markierte Felder sind Pflichtfelder.

Der vollständig qualifizierte Name (Fully Qualified Name, FQN) für Ihr App-Objekt lautet a<appId>_<objectName>. Zum Beispiel: Wenn Ihr appId 16858319 und der Name des App-Objekts CARS lautet , dann wäre a16858319_CARSder FQN. Sie verwenden den FQN, wenn Sie Bereichswerte für Ihre App-Objekte festlegen.

App-Design

Um ein App-Objekt zu erstellen, fügen Sie eine app-hsmeta.json-Konfigurationsdatei in das app-Verzeichnis ein.
Nachfolgend finden Sie die Konfigurationsoptionen für app-hsmeta.json.
Beachten Sie die folgenden Änderungen für App-Kartenkonfigurationsdateien:
  • uid-, type- und config-Felder der obersten Ebene wurden hinzugefügt.
  • extensions-Feld wurde entfernt.
  • distribution-Feld wurde hinzugefügt.

Beispiel auf GitHub anzeigen

*-hsmeta.json-Felder für das App-Schema

Mit * markierte Felder sind Pflichtfelder.

Authentifizierungsfelder

Mit * markierte Felder sind Pflichtfelder.

Bereiche

Im auth-Feld einer App-Konfigurationsdatei können Sie drei Arten von Bereichen angeben: erforderliche Bereiche, bedingt erforderliche Bereiche und optionale Bereiche. Für diese Phase der Beta sollten Sie nur Ihre App-Objektbereiche als conditionallyRequiredScopeseinschließen. Auf diese Weise können Sie Ihre neuen Funktionen für bestimmte Kunden isolieren, indem Sie die App-Objektbereiche in die Installations-URL aufnehmen. App-Objektbereiche haben das folgende Format: crm.app.schemas.<appObjectFullyQualifiedName>.read Für ein App-Objekt mit dem FQN a16858319_cars wäre der read-Bereich beispielsweise: crm.app.schemas.a16858319_cars.read. Ihre App muss mindestens den oben genannten read-Bereich enthalten, damit Kunden auf das Objekt zugreifen können. Es wird empfohlen, alle App-Objektbereiche in Ihrer App zu berücksichtigen, wie im Folgenden angegeben.
Eine vollständige Liste der verfügbaren Bereiche finden Sie in der Referenz zu Bereichen.

Definition von Webhooks-Komponenten

Um einen Satz von Webhook-Abonnements für Ihre App zu definieren, müssen Sie ein webhooks-Verzeichnis zusammen mit einer *-hsmeta.json-Konfigurationsdatei in das Projekt einschließen.
Nachfolgend finden Sie die verfügbaren Konfigurationsoptionen für die *-hsmeta.json-Datei.

*-hsmeta.json-Felder für Webhooks

Mit * markierte Felder sind Pflichtfelder.

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

Schema der App-Karte

Um eine App-Karte zu erstellen, die auf einer App-Objekt-Datensatzseite angezeigt wird, schließen Sie ein cards-Komponentenverzeichnis zusammen mit einer Konfigurationsdatei in das Projekt ein.
  • Stellen Sie sicher, dass Sie hs project upload ausgeführt haben, nachdem Sie Ihre App-Objektkomponente und die zugehörigen Konfigurationsdateien erstellt haben.
  • Fügen Sie in Ihrer my-app-card-hsmeta.json-Datei die UID Ihres App-Objekts zum objectTypes-Array hinzu (z. B . hier "app_object_uid"). Jedes der verfügbaren Felder in der .json-Datei ist in der folgenden Tabelle aufgeführt.
Beachten Sie die folgenden Änderungen für App-Kartenkonfigurationsdateien:
  • uid-, type- und config-Felder der obersten Ebene wurden hinzugefügt.
  • Das module-Feld wurde in entrypoint umbenannt.
  • Das title-Feld wurde in name umbenannt.
  • Das objectTypes-Feld wurde vereinfacht, um ein Zeichenfolgen-Array zu akzeptieren.
  • Nachdem Sie die Änderungen an Ihrer example-card-hsmeta.json-Datei gespeichert haben, führen Sie hs project upload aus.
Karten werden automatisch zur Standardansicht für App-Objekte hinzugefügt. Wenn die Karte nicht automatisch angezeigt wird, erfahren Sie hier, wie Sie Karten zu CRM-Datensätzen hinzufügen.

Beispiel auf GitHub anzeigen

Felder für *-hsmeta.json-App-Karten

Mit * markierte Felder sind Pflichtfelder.

App-Objektzuordnungen

Um Verknüpfungen zwischen Ihrem App-Objekt und anderen CRM-Objekten zu ermöglichen, fügen Sie ein app-object-associations-Komponentenverzeichnis zusammen mit einer Konfigurationsdatei in das Projekt ein.
Nachfolgend sind die verfügbaren Konfigurationsoptionen für App-Objekte (*-association-hsmeta.json) aufgeführt.

*-Zuordnungs-hsmeta.json-Felder zur Zuordnung

Mit * markierte Felder sind Pflichtfelder.

Zuletzt geändert am 10. Februar 2026