Webhooks mit HubSpot-Workflows verwenden

Verwenden Sie Webhooks in Workflows zum Senden oder Abrufen von Informationen zwischen HubSpot und anderen externen Tools. Es gibt eine Vielzahl von Verwendungszwecken für Webhooks. Hier einige Beispiele für beliebte Anwendungsfälle für Webhooks:

• Posting von HubSpot-Kontaktdaten an ein anderes System, z. B. ein CRM, wenn dieser Kontakt ein bestimmtes Formular auf Ihrer Site ausfüllt.

• Senden von Deal-Daten an ein Versandabwicklungssystem, um eine Bestellung zu erstellen.

• Abrufen von Daten aus einem anderen System zur Aktualisierung Ihrer HubSpot-Datensätze. 

Sie können sowohl POST- als auch GET-Anfragen mithilfe von Workflows senden. HubSpot reguliert Webhook-Traffic separat von anderen Workflow-Prozessen. Dies geschieht, um die Workflow- und Webhook-Performance zu optimieren. Wenn ein Webhook langsam ist oder abläuft, kann die Ausführung der Workflow-Aktion länger als erwartet dauern.

Bitte beachten: HubSpot versucht für bis zu drei Tage, fehlgeschlagene Webhooks erneut auszuführen, und beginnt damit eine Minute nach dem Fehler. Nachfolgende fehlgeschlagene Webhooks werden in größeren Intervallen mit einer maximalen Lücke von acht Stunden versucht, erneut auszuführen. Workflows versuchen es nicht erneut, nachdem sie Antwort-Statuscodes der Serie 4XX erhalten haben.
Eine Ausnahme von dieser Regel sind 429-Ratenbeschränkungsfehler; Workflows versuchen es automatisch erneut, nachdem sie eine 429-Antwort erhalten haben, und beachten die Kopfzeile Retry-After, falls vorhanden. Wiederholungsversuch nach wird in Milisekunden aufgezeichnet. Erfahren Sie mehr über spezielle Fehlercode-Ausnahmen in der Entwicklerdokumentation von HubSpot.

In der Dokumentation für Entwickler erfahren Sie mehr über Webhooks. In den HubSpot-Entwicklerforen erhalten Sie Antworten auf Fragen zu Ihrer spezifischen Implementierung von Webhooks in HubSpot.

Einrichten einer POST-Anfrage

• Gehen Sie in Ihrem HubSpot-Account zu Automatisierungen > Workflows.
• Um einen bestehenden Workflow zu bearbeiten, klicken Sie auf den Namen des Workflows. Oder erstellen Sie unter einen neuen Workflow.
• Klicken Sie im Workflow-Editor auf das Symbol + Plus, um eine Aktion hinzuzufügen.
• Wählen Sie im linken Bereich im Abschnitt Data ops die Option Webhook senden.
   

• Klicken Sie auf das Dropdown-Menü Methode und wählen Sie POST. 
• Geben Sie die Webhook-URL ein.
  • Webhook-URLs sind auf sichere Protokolle beschränkt und müssen mit HTTPS beginnen.
  • Um spezifische Informationen anzufordern, können Sie Abfrageparameter wie ?queryparameter=abc zur Webhook-URLhinzufügen.
  • Wenn keine Abfrageparameter hinzugefügt wurden, wird eine generische POST- oder GET-Anfrage gesendet. 
• Richten Sie Ihren Authentifizierungstyp ein, um Anfragen an Ihren Webhook zu authentifizieren. Sie können entweder eine Anfragesignatur in Ihrer Webhook-Kopfzeile oder einen API-Schlüssel verwenden:
  • So verwenden Sie eine Anfragesignatur in Ihrem Webhook-Header: 
    • Klicken Sie auf das Dropdown-Menü „Authentifizierungstyp“. Wählen Sie dann „Anfragesignatur in Header berücksichtigen“ aus.
    • Geben Sie dann Ihre HubSpot-App-ID ein. Erfahren Sie, wie man Anfragesignaturen überprüft.

• • Zur Verwendung eines API-Schlüssels oder einer öffentlichen App, die über einen Developer Account erstellt wurde, zur Authentifizierung:

• • • Bei der Verwendung eines API-Schlüssels zur Authentifizierung hängen der API-Schlüsselname und der Speicherort des API-Schlüssels davon ab, wie der Webhook konfiguriert ist. Aus Sicherheitsgründen wird der API-Schlüssel bei Testanfragen nicht angezeigt. So verwenden Sie einen API-Schlüssel: 
      • Klicken Sie auf das Dropdown-Menü „Authentifizierungstyp“. Wählen Sie dann „API-Schlüssel“ aus. 

• • • • Geben Sie den Namen Ihres API-Schlüssels ein.
      • Klicken Sie auf das Dropdown-Menü „Speicherort des API-Schlüssels“. Wählen Sie dann entweder „Abfrageparameter“ oder „Anfrage-Header“ aus. Erfahren Sie mehr über die Verwendung von API-Schlüsseln in HubSpot.
    • Wenn Sie eine Anfrage an die HubSpot-APIs stellen:
      • Klicken Sie auf das Dropdown-Menü „API-Schlüssel“ und wählen Sie ein Geheimnis aus. Der Geheimnis-Wert muss das Format Bearer [IHR_TOKEN] haben.
      • Legen Sie den Wert für den API-Schlüsselnamen auf „Autorisierung“ fest.
      • Legen Sie den Wert für den API-Schlüssel auf „Anfrage-Header“ fest.

• Um alle Eigenschaften zu berücksichtigen, wählen Sie Alle Eigenschaften berücksichtigen [Objekt]. 
• So berücksichtigen Sie nur bestimmte Eigenschaften:
  
  • Wählen Sie Anforderungsstext anpassen.
  • Um den Anforderungstext mithilfe einer HubSpot-Eigenschaft anzupassen, geben Sie den Key ein und wählen Sie eine Eigenschaftaus. Klicken Sie auf „Eigenschaft hinzufügen“, um eine weitere Eigenschaft hinzuzufügen.
  • Um den Anforderungstext über ein statisches Feld anzupassen, geben Sie den Schlüssel und Wertein. Um eine weitere Eigenschaft hinzuzufügen, klicken Sie auf Statischen Wert hinzufügen.

• • Um eine Eigenschaft oder einen statischen Wert zu entfernen, klicken Sie auf das Papierkorb-Symbol delete .
• Klicken Sie auf Speichern. 

Bitte beachten: Um mehrere Ausgaben auszuwählen, sollte die Antwort als JSON-Objekt strukturiert sein.

Setup einer GET-Anfrage

• Gehen Sie in Ihrem HubSpot-Account zu Automatisierungen > Workflows.
• Um einen bestehenden Workflow zu bearbeiten, klicken Sie auf den Namen des Workflows. Oder erstellen Sie unter einen neuen Workflow.
• Klicken Sie im Workflow-Editor auf das Symbol + Plus, um eine Aktion hinzuzufügen.
• Wählen Sie im linken Bereich im Abschnitt Data ops die Option Webhook senden.
   

• Klicken Sie auf das Dropdown-Menü Methode und wählen Sie GET. 
• Geben Sie die Webhook-URL ein.
  • Webhook-URLs sind auf sichere Protokolle beschränkt und müssen mit HTTPS beginnen.
  • Um spezifische Informationen anzufordern, können Sie Abfrageparameter wie ?queryparameter=abc zur Webhook-URLhinzufügen.
  • Wenn keine Abfrageparameter hinzugefügt wurden, wird eine generische POST- oder GET-Anfrage gesendet. 
• Richten Sie Ihren Authentifizierungstyp ein, um Anfragen an Ihren Webhook zu authentifizieren. Sie können entweder eine Anfragesignatur in Ihrer Webhook-Kopfzeile oder einen API-Schlüssel verwenden:
  • So verwenden Sie eine Anfragesignatur in Ihrem Webhook-Header: 
    • Klicken Sie auf das Dropdown-Menü „Authentifizierungstyp“. Wählen Sie dann „Anfragesignatur in Header berücksichtigen“ aus.
    • Geben Sie dann Ihre HubSpot-App-ID ein. Erfahren Sie, wie man Anfragesignaturen überprüft.

• • Zur Verwendung eines API-Schlüssels oder einer öffentlichen App, die über einen Developer Account erstellt wurde, zur Authentifizierung:

• • • Bei der Verwendung eines API-Schlüssels zur Authentifizierung hängen der API-Schlüsselname und der Speicherort des API-Schlüssels davon ab, wie der Webhook konfiguriert ist. Aus Sicherheitsgründen wird der API-Schlüssel bei Testanfragen nicht angezeigt. So verwenden Sie einen API-Schlüssel: 
      • Klicken Sie auf das Dropdown-Menü „Authentifizierungstyp“. Wählen Sie dann „API-Schlüssel“ aus. 

• • • • Geben Sie den Namen Ihres API-Schlüssels ein.
      • Klicken Sie auf das Dropdown-Menü „Speicherort des API-Schlüssels“. Wählen Sie dann entweder „Abfrageparameter“ oder „Anfrage-Header“ aus. Erfahren Sie mehr über die Verwendung von API-Schlüsseln in HubSpot.
    • Wenn Sie eine Anfrage an die HubSpot-APIs stellen:
      • Klicken Sie auf das Dropdown-Menü „API-Schlüssel“ und wählen Sie ein Geheimnis aus. Der Geheimnis-Wert muss das Format Bearer [IHR_TOKEN] haben.
      • Legen Sie den Wert für den API-Schlüsselnamen auf „Autorisierung“ fest.
      • Legen Sie den Wert für den API-Schlüssel auf „Anfrage-Header“ fest.

• So verwenden Sie eine HubSpot-Eigenschaft als Abfrageparameter: 
  • Geben Sie im Abschnitt „Abfrageparameter“ den Schlüssel ein und wählen Sie dann eine Eigenschaft aus.
  • Klicken Sie auf „Eigenschaft hinzufügen“, um eine weitere Eigenschaft hinzuzufügen.
  • Um eine Eigenschaft zu entfernen, klicken Sie auf das delete Papierkorb-Symbol. 
• Um einen statischen Wert als Abfrageparameter zu verwenden: 
  • Geben Sie unter dem Abschnitt Abfrageparameter den Schlüssel ein, und geben Sie dann einen Wert ein.
  • Um eine weitere Eigenschaft hinzuzufügen, klicken Sie auf Statischen Wert hinzufügen.
  • Um eine Eigenschaft zu entfernen, klicken Sie auf das delete Papierkorb-Symbol. 
• Klicken Sie auf Speichern. 

Testen Sie Ihren Webhook in HubSpot

Wenn Sie Ihren POST- oder GET-Webhook einrichten, können Sie einen Test ausführen, um die Webhook-Antwort anzuzeigen. Während des Tests werden zwar Daten an einen Dritten gesendet und von diesem abgerufen, bestehende Datensätze in HubSpot sind davon jedoch nicht betroffen. Wenn Sie einen API-Schlüssel zur Authentifizierung verwenden, wird der API-Schlüssel in Testanfragen nicht angezeigt.

Nachdem Sie Ihren Webhook getestet haben, können Sie auswählen, welche Felder Sie ausgeben möchten, um sie später in Ihrem Workflow als Eingaben zu nutzen. Wählen Sie nur Ausgänge aus, die in jeder Antwort verfügbar sind. Wenn die Ausgabe in einer späteren Aktion verwendet wird, in der Antwort jedoch nicht verfügbar ist, schlägt die Aktion fehl. 

• Gehen Sie in Ihrem HubSpot-Account zu Automatisierungen > Workflows.
• Klicken Sie auf den Namen des Workflows. 
• Klicken Sie im Workflow-Editor auf die Aktion Einen Webhook senden.
• Klicken Sie im linken Bereich auf Aktion testen, um den Abschnitt zu erweitern. 
• Wenn Sie eine POST-Anfrage testen, klicken Sie auf das Dropdown-Menü [Objekt] und wählen Sie dann einen Datensatz aus, mit dem Sie testen möchten.
• Klicken Sie auf „Testen“. 
• Um die Details des Webhooks zu überprüfen, wählen Sie die Registerkarte „Antwort“ oder „Anfrage“ aus. Auf jeder Registerkarte können Sie auf „Alle öffnen“ klicken, um alle Abschnitte zu erweitern, oder auf „Alle einklappen“, um alle Abschnitte auszublenden.
  
  • Klicken Sie auf der Registerkarte „Antwort“ auf headers: oder body:, um die einzelnen Abschnitte zu erweitern. 
  • Klicken Sie auf der Registerkarte „Anfrage“ auf httpHeaders:, um den Abschnitt zu erweitern.
    
    

Webhook extern testen

Nachdem Sie Ihren Workflow mit einer Webhook-Aktion erstellt haben, können Sie einen Schnelltest mit einem Webhook-URL-Dummy durchführen.

• Gehen Sie In Ihrem Browser zu https://webhook.site und kopieren Sie die eindeutige URL.
• Fügen Sie in der Webhook-Aktion im Feld Webhook-URL die URL ein.
• Sobald Ihr Workflow aktiviert ist, können Sie einen Testkontakt manuell einschreiben. 
  
  

• Wenn Sie Ihren Webhook extern testen:
  • Wird eine Webhook-Aktion mit einer POST-Anfrage ausgelöst, wird ein JSON-Antworttext an den Webhook gesendet, der alle Informationen zum Kontakt enthält, einschließlich Formulareinsendungen, Listenmitgliedschaften und alle Kontakteigenschaftswerte. Das empfangene System kann die JSON-Daten dann analysieren und für seine eigene Anwendung verwenden.
  • Wenn eine Webhook-Aktion mit einer GET-Anfrage ausgelöst wird, wird eine generische GET-Anfrage gesendet, sofern keine zusätzlichen Abfrageparameter angegeben wurden. 

Bitte beachten: Vorherige Eigenschaftswerte werden nur in kontaktbasierten Workflows zurückgegeben. In allen anderen Workflow-Typen verwendete Webhooks geben nur den letzten Wert zurück.

Anfragesignaturen in Workflow-Webhooks verifizieren

Wenn Sie im Abschnitt Authentifizierung für Ihre „Webhook triggern“-Aktion „Anfragesignatur“ausgewählt haben, füllt HubSpot den Webhook mit einem X-HubSpot-Signatur-Header mit einem SHA-256-Hash der Verkettung des App-Geheimnisses für Ihre Anwendung, der HTTP-Methode, dem URI und dem ungeparsten Text aus. Erfahren Sie mehr darüber in der Entwickler-Dokumentation.

Um zu überprüfen, ob die unter Ihrer URL empfangenen Anfragen von HubSpot stammen:

• Ein Entwicklerkonto besitzen. Wenn Sie keines haben, melden Sie sich für einen Entwickler-Account an.
• Eine App besitzen Wenn Sie keine App haben, lernen Sie, wie man eine App erstellt.
• Suchen Sie den hash-Wert der Signatur.

Workflows von Webhooks triggern

Webhooks können zum Triggern von Workflows verwendet werden. Wenn sich Daten in einer Anwendung eines Drittanbieters ändern, kann dies einen Workflow auslösen. Erfahren Sie mehr über Triggern von Workflows über Webhooks.

Webhook-Daten im Daten-Panel verwenden

Daten aus dem mit Ihrem Account verbundenen Webhook können für bestimmte Aktionen im Datenpanel verwendet werden.

So verwenden Sie Daten aus dem mit verbundenen Webhook:

• Gehen Sie in Ihrem HubSpot-Account zu Automatisierungen > Workflows.
• Klicken Sie auf den Namen Ihres Workflows.
• Klicken Sie auf das + Plus-Symbol, um eine Aktion hinzuzufügen.
• Wählen Sie im linken Bereich eine Aktion aus, die den Bereich Datenverwendet.
• Klicken Sie im Daten-Panel auf Eigenschaften oder Aktionsausgänge aus dem Dropdown-Menü anzeigen und wählen Sie Webhook triggern. Sie können dann Eigenschaften aus dem verbundenen Webhook verwenden.