Webhooks gebruiken met HubSpot workflows

Gebruik webhooks in workflows om informatie te verzenden of op te halen tussen HubSpot en andere externe tools. Er zijn verschillende gebruiksmogelijkheden voor webhooks, voorbeelden van populaire gebruikssituaties voor webhooks zijn onder andere:

• Het posten van HubSpot contactpersonen gegevens naar een ander systeem, zoals een CRM, wanneer die contactpersoon een bepaald formulier op je site invult.

• Het versturen van dealgegevens naar een extern verzendsysteem om een inkooporder aan te maken.

• Chatwaarschuwingen van uw externe systeem naar de chatstream van uw bedrijf sturen om medewerkers te laten weten dat er iets belangrijks is gebeurd.

• Gegevens ophalen uit een ander systeem om je HubSpot records bij te werken.

Je kunt zowel POST- als GET-verzoeken verzenden met behulp van workflows. HubSpot regelt webhook verkeer apart van andere workflow processen. Dit wordt gedaan om de prestaties van workflows en webhooks te stroomlijnen. Wanneer een webhook traag is of een time-out heeft, kan het langer duren dan verwacht voordat de workflow actie wordt uitgevoerd.

Let op: HubSpot zal mislukte webhooks tot drie dagen lang opnieuw proberen, beginnend één minuut na de mislukking. Latere mislukkingen worden met toenemende intervallen opnieuw geprobeerd, met een maximum van acht uur tussen de pogingen. Lees meer over specifieke foutcode-uitzonderingen in de HubSpot documentatie voor ontwikkelaars.

Meer informatie over webhooks in de documentatie over webhooks voor ontwikkelaars. Als je vragen hebt over je specifieke implementatie van webhooks met HubSpot, ga dan naar de HubSpot Developers Forums.

Een webhook instellen in je workflow

• Ga in je HubSpot account naar Automatisering > Workflows.
• Klik op de naam van de workflow.
• Klik op het + pictogram om een actie toe te voegen.
• Selecteer in het rechterpaneel Een webhook verzenden.
• Klik op het vervolgkeuzemenu Methode en selecteer POST of GET.
• Voer de webhook URL in. Webhook URL's zijn beperkt tot een veilig protocol en moeten beginnen met HTTPS. Om specifieke informatie op te vragen, kunt u queryparameters zoals ?queryparameter=abc toevoegen aan de Webhook URL. Als er geen queryparameters zijn toegevoegd, wordt er een algemeen POST- of GET-verzoek verzonden.
• Stel uw verificatietype in om verzoeken naar uw webhook te verifiëren:
  • Om een verzoekhandtekening in uw webhook-header te gebruiken:
    • Klik op het vervolgkeuzemenu Authenticatietype. Selecteer vervolgens Include request signature in header.
    • Voer vervolgens je HubSpot App ID in. Leer hoe je verzoekhandtekeningen kunt verifiëren.

• • Je kunt ook een API-sleutel of een openbare app die is gemaakt via een ontwikkelaarsaccount gebruiken voor verificatie.

Let op: vanaf 30 november 2022 worden HubSpot API-sleutels niet meer ondersteund. Je kunt nog steeds externe API-sleutels gebruiken voor verificatie in HubSpot workflows.

• • • Wanneer je een API-sleutel gebruikt voor verificatie, zijn de gebruikte API-sleutelnaam en API-sleutellocatie afhankelijk van hoe de webhook is geconfigureerd. Om veiligheidsredenen wordt de API-sleutel niet weergegeven in testverzoeken. Om een API-sleutel te gebruiken:
      • Klik op het vervolgkeuzemenu Authenticatietype. Selecteer vervolgens API-sleutel.

• • • • Voer de naam van uw API-sleutel in.
      • Klik op het vervolgkeuzemenu API-sleutellocatie. Selecteer vervolgens Query parameters of Request header. Meer informatie over het gebruik van API-sleutels in HubSpot.
    • Als je een verzoek indient bij een van onze HubSpot API's:
      • Klik op het vervolgkeuzemenu API-sleutel en selecteer een geheim. De geheime waarde moet in het formaat Bearer [YOUR_TOKEN] zijn.
      • Stel de waarde van API-sleutelnaam in op Autorisatie.
      • Stel de waarde van de locatie van de API-sleutel in op Request Header.
• Als u een POST-verzoek instelt, kunt u ervoor kiezen om alle eigenschappen van het CRM-record op te nemen of alleen specifieke eigenschappen te verzenden:
  • Om alle eigenschappen op te nemen, selecteert u in de sectie Request body aanpassen Alle eigenschappen opnemen.
  • Als u alleen specifieke eigenschappen wilt opnemen:
    
    • Selecteer Choose specific properties in het gedeelte Customize request body.
    • Klik op het vervolgkeuzemenu Kies eigenschap. Klik vervolgens op [object] in deze workflow en selecteer een eigenschap.
    • Om de naam van een eigenschap in de webhook te wijzigen, bewerkt u het tekstveld Naam eigenschap . Dit zal alleen de naam van de eigenschap in het POST-verzoek bijwerken, het zal de naam van de eigenschap of de interne naam in HubSpot niet bijwerken.
    • Om nog een eigenschap toe te voegen, klik je op eigenschap toevoegen.
    • Om een eigenschap te verwijderen, klik je op het pictogram delete prullenbak.
      

• Als je een GET-verzoek instelt, kun je eigenschappen gebruiken als queryparameters:
  
  • Klik in de sectie Query parameters op het keuzemenu Kies eigenschap. Klik vervolgens op [object] in deze workflow en selecteer een eigenschap.
  • Om de naam van een eigenschap in de queryparameter te wijzigen, bewerk je het tekstveld Eigendomsnaam . Dit zal alleen de property naam in het GET verzoek bijwerken, het zal de property naam of interne naam in HubSpot niet bijwerken.
  • Om nog een eigenschap toe te voegen, klik je op Queryparameter toevoegen.
  • Om een eigenschap te verwijderen, klik je op het pictogram delete prullenbak.
• Klik op Opslaan.
  
  

Let op: om meerdere uitgangen te selecteren, moet het antwoord gestructureerd zijn als een JSON-object.

Uw POST-verzoek aanpassen

Als u een POST-verzoek instelt, kunt u ervoor kiezen om alle eigenschappen van het CRM-record op te nemen of alleen specifieke eigenschappen te verzenden:

• Als u alle eigenschappen wilt opnemen, selecteert u Include all properties in de sectie Customize request body.
• Als u alleen specifieke eigenschappen wilt opnemen:
  
  • Selecteer Customize request body in de sectie Request body.
  • Voer de sleutel en waarde in.
  • Als u de naam van een eigenschap in de webhook wilt wijzigen, bewerkt u het tekstveld Sleutel . Dit zal alleen de naam van de eigenschap in het POST-verzoek bijwerken, het zal de naam van de eigenschap of de interne naam in HubSpot niet bijwerken.
  • Om nog een eigenschap toe te voegen, klik je op eigenschap toevoegen.
  • Om een eigenschap te verwijderen, klik je op het pictogram delete prullenbak.
    
    

Uw GET-verzoeken aanpassen

Als je een GET-verzoek instelt, kun je eigenschappen gebruiken als queryparameters om specifieke gegevens op te halen:

• Voer in de sectie Queryparameters de sleutel in en selecteer vervolgens een eigenschap.
• Om de naam van een eigenschap in de queryparameter te wijzigen, bewerk je het tekstveld Naam eigenschap . Dit zal alleen de property naam in het GET verzoek bijwerken, het zal de property naam of interne naam in HubSpot niet bijwerken.
• Om nog een eigenschap toe te voegen, klik je op eigenschap toevoegen.
• Om een eigenschap te verwijderen, klik je op het pictogram delete prullenbak.
• Selecteer een verificatietype in het vervolgkeuzemenu.
• Klik op Opslaan.
  
  

Test je webhook binnen HubSpot

Bij het instellen van je POST of GET webhook, kun je een test uitvoeren om de webhook respons te bekijken. Tijdens de test, terwijl gegevens worden verzonden naar en opgehaald van een derde partij, worden bestaande records in HubSpot niet beïnvloed. Als je een API-sleutel gebruikt voor authenticatie, wordt de API-sleutel niet weergegeven in testverzoeken.

Nadat je je webhook hebt getest, kun je selecteren welke velden je wilt uitvoeren om later in je workflow als invoer te gebruiken. Selecteer alleen uitvoer die beschikbaar is in elke respons. Als de uitvoer wordt gebruikt in een latere actie, maar niet beschikbaar is in de respons, zal de actie mislukken.

• Klik in het zijpaneel op Testactie om de sectie uit te vouwen.
• Klik op het vervolgkeuzemenu Object en selecteer een record om mee te testen.
• Klik op Testen.
• Om de details van de webhook te controleren, selecteert u het tabblad Response of Request. Op elk tabblad kunt u klikken op Alles openen om alle secties uit te vouwen of Alles samenvouwen om alle secties samen te vouwen.
  
  • Klik op het tabblad Reactie op headers: of body: om elke sectie uit te vouwen.
  • Klik op het tabblad Request op httpHeaders: om de sectie uit te vouwen.
    
    

Uw webhook extern testen

Nadat u uw workflow met een webhook actie hebt gemaakt, kunt u een snelle test uitvoeren met een dummy webhook URL:

• Navigeer in uw browser naar https://webhook.site en kopieer de unieke URL.
• Plak de URL in het veld Webhook URL in uw webhook-actie.

• Zodra je workflow is ingeschakeld, kun je handmatig een testcontact inschrijven.

Als een webhook-actie met een POST-verzoek wordt geactiveerd, wordt er een JSON-antwoordcorpus naar de webhook verzonden met alle informatie over de contactpersoon, inclusief formulierinzendingen, lidmaatschappen van lijsten en alle waarden van contacteigenschappen. Het ontvangende systeem kan de JSON-gegevens vervolgens ontleden en gebruiken voor zijn eigen toepassing.

Als een webhook-actie met een GET-verzoek wordt geactiveerd, wordt een generiek GET-verzoek verzonden, tenzij aanvullende queryparameters zijn toegepast.

Let op: historische waarden van eigenschappen worden alleen geretourneerd in contactgebaseerde workflows. Webhooks die worden gebruikt in alle andere workflowtypen zullen alleen de meest recente waarde retourneren.

Verzoekhandtekeningen in workflow webhooks controleren

Wanneer je Request signature hebt geselecteerd in de Authentication sectie voor je Trigger a webhook actie, zal HubSpot de webhook vullen met een X-HubSpot-Signature header met een SHA-256 hash van de aaneenschakeling van het app-secret voor je applicatie, de HTTP-methode, de URI en de ongeparsde body. Lees meer hierover in de documentatie voor ontwikkelaars.

Om te controleren of de verzoeken die op je URL worden ontvangen, afkomstig zijn van HubSpot:

• Bezit een ontwikkelaarsaccount. Als je er geen hebt, meld je dan aan voor een ontwikkelaarsaccount.
• Een app bezitten. Als je geen app hebt, leer dan hoe je een app kunt maken.
• Controleer de hashwaarde van de handtekening.

Workflows van webhooks triggeren

Webhooks kunnen worden gebruikt om workflows te triggeren. Wanneer gegevens in een app van derden veranderen, kan dit een workflow triggeren. Meer informatie over het triggeren van workflows via webhooks.

Webhookgegevens gebruiken in het gegevenspaneel

Gegevens van de webhook die is gekoppeld aan je account kunnen worden gebruikt voor bepaalde acties in het gegevenspaneel.

Om gegevens van de verbonden webhook te gebruiken:

• Ga in je HubSpot account naar Automatisering > Workflows.
• Klik op de naam van uw workflow.
• Klik op het plus-pictogram om een actie toe te voegen.
• Selecteer in het linkerpaneel een actie die het gegevenspaneel gebruikt.
• In het datapaneel kun je onder Eigenschappen inschakelen een van de eigenschappen van de gekoppelde webhook selecteren.