Diese Endpunkte ermöglichen es HubSpot-Benutzern, mit in anderen Systemen gespeicherten Informationen zu interagieren.
crm.objects.contacts.read
und crm.objects.contacts.write
verfügen. Wenn Sie später CRM-Objektbereiche von Ihrer App entfernen müssen, müssen Sie zunächst alle vorhandenen Karten für diese Objekttypen löschen.
Weitere Informationen zu Bereichen und zum Einrichten der Autorisierungs-URL für Ihre App finden Sie in der OAuth-Dokumentation.
targetUrl
-Feld hinzugefügt.objectTypes
-Array hinzugefügt.GET
-Anfrage wie folgt sendet.
Parameter | Typ | Beschreibung |
---|---|---|
userId | Standard | Die ID des HubSpot-Benutzers, der den CRM-Datensatz geladen hat. |
userEmail | Standard | Die E-Mail-Adresse des Benutzers, der den CRM-Datensatz geladen hat. |
associatedObjectId | Standard | Die ID des CRM-Datensatzes, der geladen wurde. |
associatedObjectType | Standard | Der Typ des CRM-Datensatzes, der geladen wurde (z. B. Kontakt, Unternehmen, Deal). |
portalId | Standard | Die ID des HubSpot-Accounts, in das der CRM-Datensatz geladen wurde. |
firstname | Benutzerdefiniert | Der Vorname des Kontakts, wie im Dropdown-Menü Von HubSpot gesendete Eigenschaften (in der App) und im propertiesToSend -Array (API) angegeben. |
email | Benutzerdefiniert | Die E-Mail-Adresse des Kontakts, wie im Dropdown-Menü Von HubSpot gesendete Eigenschaften (in der App) und im propertiesToSend -Array (API) angegeben. |
lastname | Benutzerdefiniert | Der Nachname des Kontakts, wie im Dropdown-Menü Von HubSpot gesendete Eigenschaften (in der App) und im propertiesToSend -Array (API) angegeben. |
Eigenschaft | Typ | Beschreibung |
---|---|---|
results | Array | Ein Array mit bis zu fünf gültigen Karteneigenschaften. Wenn für ein bestimmtes CRM-Objekt weitere Karteneigenschaften verfügbar sind, kann Ihre App zu ihnen verlinken. |
objectId | Zahl | Eine eindeutige ID für dieses Objekt. |
title | Zeichenfolge | Der Titel dieses Objekts. |
link | Zeichenfolge | Die URL, der der Benutzer folgen kann, um weitere Details zum Objekt abzurufen. Wenn jedoch keine Objekte über einen Link verfügen, sollten Sie den Wert null angeben. |
created | Zeichenfolge | Eine benutzerdefinierte Eigenschaft, wie in den Einstellungen der Karte definiert, die das Datum der Objekterstellung angibt. |
priority | Zeichenfolge | Eine benutzerdefinierte Eigenschaft, wie in den Einstellungen der Karte definiert, die die Prioritätsstufe eines externen Tickets angibt. |
actions | Array | Eine Liste mit verfügbaren Aktionen, die ein Benutzer durchführen kann. |
properties | Eigenschaften | Eine Liste benutzerdefinierter Eigenschaften, die nicht in den Karteneinstellungen definiert sind. Sie können diese Liste verwenden, um eindeutige Eigenschaften eines bestimmten Objekts anzuzeigen. Diese Eigenschaften werden in der Reihenfolge angezeigt, in der sie angegeben werden, aber nach den in den Karteneinstellungen definierten Eigenschaften. |
settingsAction | Objekt | Eine iframe-Aktion, mit der Benutzer die Einstellungen der App aktualisieren können. |
primaryAction | Objekt | Die primäre Aktion für einen Datensatztyp, in der Regel eine erstellende Aktion. |
secondaryActions | Array | Eine Liste der auf der Karte angezeigten Aktionen. |
X-HubSpot-Signature: <some base64 string>
Um diese Signatur zu überprüfen, führen Sie die folgenden Schritte aus:
<app secret>
+ <HTTP method>
+ <URL>
+ <request body> (if present)
.results
bereitstellen. Zusätzlich zu den auf dieser Registerkarte konfigurierten Eigenschaften kann die Integration auch eigene benutzerdefinierte Eigenschaften enthalten, ohne dass diese in den Einstellungen der Karte definiert werden müssen.
Beispielsweise werden in der Antwort unten sowohl created
als auch priority
auf der Registerkarte Karteneigenschaften definiert, während das properties
-Array seine eigenen Eigenschaftsdefinitionen und -werte sendet. Diese objektspezifischen Eigenschaften müssen pro Objekt definiert werden.
dataType
-Feld für jede Eigenschaft auf einen der folgenden Werte festgelegt werden: CURRENCY
, DATE
, DATETIME
, EMAIL
, LINK
, NUMERIC
, STATUS
, STRING
. Abhängig vom Eigenschaftstyp muss die Integration möglicherweise zusätzliche Felder bereitstellen. Im Folgenden erfahren Sie mehr über die einzelnen Eigenschaftstypen.
CURRENCY
-Eigenschaften müssen einen currencyCode
enthalten, der ein gültiger ISO 4217-Code sein muss. Dadurch wird sichergestellt, dass der Benutzer das richtige Währungssymbol und die richtige Zahlenformatierung sieht.
DATE
-Eigenschaften sollten das Format yyyy-mm-dd
haben. Diese Eigenschaften werden in einem Format angezeigt, das dem Gebietsschema des Benutzers entspricht. Wenn Sie einen Zeitstempel einfügen müssen, sollten Sie stattdessen eine DATETIME
-Eigenschaft verwenden.
DATETIME
-Eigenschaften geben eine bestimmte Zeit an und müssen als Millisekunden seit Epoche angegeben werden. Diese Eigenschaften werden in einem Format angezeigt, das dem Gebietsschema des Benutzers entspricht.
EMAIL
-Eigenschaften sind für Werte vorgesehen, die eine E-Mail-Adresse enthalten. Diese Eigenschaften werden als mailto-Links angezeigt.
LINK
-Eigenschaften zeigen Hyperlinks an und werden in einem neuen Fenster geöffnet. Sie können ein linkLabel
spezifizieren, andernfalls wird die URL selbst angezeigt.
NUMERIC
Eigenschaften zeigen Zahlen an.
STATUS
-Eigenschaften werden als farbige Indikatoren angezeigt. Um eine Status-Eigenschaft zu definieren, muss die Integration einen optionType
bereitstellen, der die möglichen Status beschreibt. Zu den Status gehören:
DEFAULT
: GrauSUCCESS
: GrünWARNING
: GelbDANGER
: RotINFO
: BlauSTRING
-Eigenschaften zeigen Text an.
X-HubSpot-Signature
-Header zur Überprüfung der Anfrage. Iframe-Aktionsanfragen enthalten keine Anfragesignatur. Siehe Anfragesignaturen für weitere Informationen.
Auf Aktions-URLs wird im uri
-Feld in einer Aktion zugegriffen. Ähnlich wie bei einer Datenabrufanfrage enthalten Aktionshooks einen Standardsatz von Abfrageparametern. Sie können andere Abfrageparameter einbeziehen, indem Sie ein zugeordnetes associatedObjectProperties
-Feld in die Aktion einbeziehen.
Die Antwort hängt vom Aktionstyp ab. Im Folgenden erfahren Sie mehr über Aktionstypen.
IFRAME
-Aktionen öffnen ein modales Dialogfeld mit einem iframe, der auf die angegebene URL verweist. Es wird keine Anfragesignatur gesendet, wenn der iframe über die CRM-UI geöffnet wird. Dies liegt daran, dass die iframe-URL in der ursprünglichen Datenabruf-Anfrage zurückgegeben wird. Es sind keine weiteren Proxy-Anfragen erforderlich.
window.postMessage
die Integration dem CRM signalisieren, dass der Benutzer fertig ist. Die folgenden Nachrichten werden akzeptiert:
{"action": "DONE"}
: Der Benutzer hat die Aktion erfolgreich abgeschlossen.{"action": "CANCEL"}
: Der Benutzer hat die Aktion abgebrochen.ACTION_HOOK
-Aktionen senden einen serverseitige Anfrage an eine App. Der einzige UI, die ein Benutzer für diese Aktion sieht, ist eine Erfolgsmeldung oder eine Fehlermeldung. Diese Art von Aktion ist hilfreich bei einfachen Operationen, die keine weiteren Eingaben des Benutzers erfordern. Ein X-HubSpot-Signature
-Header wird in die Anfrage zur Überprüfung aufgenommen. Erfahren Sie mehr über Anfragesignaturen.
httpMethod
kann auf GET
, POST
, PUT
, DELETE
oder PATCH
festgelegt werden. Bei Verwendung von GET
oder DELETE
werden die associatedObjectProperties
-Werte als Abfrageparameter an die Anfrage-URL angehängt. Andernfalls werden die Eigenschaften im Anfragetext gesendet.
CONFIRMATION_ACTION_HOOK
-Aktionen verhalten sich wie ACTION_HOOK
-Aktionen, außer dass dem Benutzer ein Bestätigungsdialogfeld angezeigt wird, bevor die serverseitige Anfrage ausgeführt wird. Ein X-HubSpot-Signature
-Header wird in die Anfrage zur Überprüfung aufgenommen. Erfahren Sie mehr über Anfragesignaturen.
httpMethod
kann auf GET
, POST
, PUT
, DELETE
oder PATCH
festgelegt werden. Bei Verwendung von GET
oder DELETE
werden die associatedObjectProperties
-Werte als Abfrageparameter an die Anfrage-URL angehängt. Andernfalls werden die Eigenschaften im Anfragetext gesendet.