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:

• Senden von HubSpot-Kontaktdaten an ein anderes System, zum Beispiel CRM, wenn der betreffende Kontakt ein bestimmtes Formular auf Ihrer Website ausfüllt.

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

• Senden von Chat-Warnungen von Ihrem externen System an den Chat-Stream Ihres Unternehmens, um Mitarbeiter über wichtige Ereignisse zu informieren.

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

 Einen Webhook in Ihrem Workflow einrichten

• Gehen Sie in Ihrem HubSpot-Account zu Automatisierung > Workflows.
• Klicken Sie auf den Namen des Workflows.
• Klicken Sie auf das Plus-Symbol (+), um eine Aktion hinzuzufügen.
• Wählen Sie im rechten Bereich „Webhook senden“ aus.
• Klicken Sie auf das Dropdown-Menü „Methode“ und wählen Sie dann POST oder GET aus. 
• 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 der Webhook-URL Abfrageparameter wie ?queryparameter=abc hinzufü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: 
  • 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.

• • Sie können auch einen API-Schlüssel oder eine private HubSpot-App zur Authentifizierung verwenden.

Bitte beachten: Seit dem 30. November 2022 sind HubSpot-API-Schlüssel veraltet und werden nicht mehr unterstützt. Sie können weiterhin externe API-Schlüssel für die Authentifizierung in HubSpot-Workflows verwenden.

• • • 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 eine unserer HubSpot-APIs durchführen:
      • 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.
• Wenn Sie eine POST-Anfrage einrichten, können Sie auswählen, ob Sie alle Eigenschaften des CRM-Datensatzes einbeziehen oder nur bestimmte Eigenschaften senden möchten:
  • Um alle Eigenschaften einzubeziehen, wählen Sie unter dem Abschnitt „Anfragetext anpassen“ die Option „Alle Eigenschaften berücksichtigen“.  
  • So berücksichtigen Sie nur bestimmte Eigenschaften:
    
    • Wählen Sie unter dem Abschnitt „Anfragetext anpassen“ die Option „Spezifische Eigenschaften auswählen“ aus.
    • Klicken Sie auf das Dropdown-Menü „Eigenschaft auswählen“. Klicken Sie dann auf „[Objekt] in diesem Workflow“ und wählen Sie eine Eigenschaft aus.
    • Um den Namen einer Eigenschaft im Webhook zu ändern, bearbeiten Sie das Textfeld „Eigenschaftsname“. Dadurch wird nur der Eigenschaftsname in der POST-Anfrage aktualisiert, nicht aber der Eigenschaftsname oder der interne Name in HubSpot.  
    • Klicken Sie auf „Eigenschaft hinzufügen“, um eine weitere Eigenschaft hinzuzufügen.
    • Um eine Eigenschaft zu entfernen, klicken Sie auf das delete Papierkorb-Symbol.
         

• Wenn Sie eine GET-Anfrage einrichten, können Sie Eigenschaften als Abfrageparameter verwenden:
  
  • Klicken Sie unter dem Abschnitt „Abfrageparameter“ auf das Dropdown-Menü „Eigenschaft auswählen“. Klicken Sie dann auf „[Objekt] in diesem Workflow“ und wählen Sie eine Eigenschaft aus.
  • Um den Namen einer Eigenschaft im Abfrageparameter zu ändern, bearbeiten Sie das Textfeld „Eigenschaftsname“. Dadurch wird nur der Eigenschaftsname in der GET-Anfrage aktualisiert, nicht aber der Eigenschaftsname oder der interne Name in HubSpot.  

• • Klicken Sie auf „Abfrageparameter hinzufügen“, um eine weitere Eigenschaft hinzuzufügen.
  • Um eine Eigenschaft zu entfernen, klicken Sie auf das delete Papierkorb-Symbol.     
• Klicken Sie auf „Speichern“.
  
  

POST-Anfrage anpassen

Wenn Sie eine POST-Anfrage einrichten, können Sie auswählen, ob Sie alle Eigenschaften des CRM-Datensatzes einbeziehen oder nur bestimmte Eigenschaften senden möchten:

• Um alle Eigenschaften einzubeziehen, wählen Sie unter dem Abschnitt „Anfragetext anpassen“ die Option „Alle Eigenschaften berücksichtigen“.  
• So berücksichtigen Sie nur bestimmte Eigenschaften:
  
  • Wählen Sie unter dem Abschnitt „Anfragetext“ die Option „Anfragetext anpassen“.
  • Geben Sie den Schlüssel und den Wert ein.
  • Um den Namen einer Eigenschaft im Webhook zu ändern, bearbeiten Sie das Textfeld „Schlüssel“. Dadurch wird nur der Eigenschaftsname in der POST-Anfrage aktualisiert, nicht aber der Eigenschaftsname oder der interne Name in HubSpot.  
  • Klicken Sie auf „Eigenschaft hinzufügen“, um eine weitere Eigenschaft hinzuzufügen.
  • Um eine Eigenschaft zu entfernen, klicken Sie auf dasdelete Papierkorb-Symbol.
       

Ihre GET-Anfragen anpassen

Wenn Sie eine GET-Anfrage einrichten, können Sie Eigenschaften als Abfrageparameter verwenden, um spezifische Daten abzurufen: 

• Geben Sie im Abschnitt „Abfrageparameter“ den Schlüssel ein und wählen Sie dann eine Eigenschaft aus.
• Um den Namen einer Eigenschaft im Abfrageparameter zu ändern, bearbeiten Sie das Textfeld „Eigenschaftsname“. Dadurch wird nur der Eigenschaftsname in der GET-Anfrage aktualisiert, nicht aber der Eigenschaftsname oder der interne Name in HubSpot.  

• Klicken Sie auf „Eigenschaft hinzufügen“, um eine weitere Eigenschaft hinzuzufügen.
• Um eine Eigenschaft zu entfernen, klicken Sie auf das delete Papierkorb-Symbol.     
• Wählen Sie im Dropdown-Menü einen Authentifizierungstyp aus.
• Klicken Sie auf „Speichern“.
  
  

Ihren Webhook in HubSpot testen

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.

• Klicken Sie im Seitenbereich auf „Aktion testen“, um den Bereich zu erweitern. 
• Klicken Sie auf das Dropdown-Menü „Objekt“ und wählen Sie dann einen „Datensatz“ aus, mit dem getestet werden soll.
• 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 manuell einen Testkontakt aufnehmen. 

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 ein Entwicklerkonto an.
• Eine App besitzen Wenn Sie keine App haben, lernen Sie, wie man eine App erstellt.
• Suchen Sie den hash-Wert der Signatur.