Gebruik webhooks met HubSpot workflows

Gebruik webhooks in workflows om informatie te verzenden of op te halen tussen HubSpot en andere externe tools. Er zijn een verscheidenheid aan toepassingen voor webhooks, voorbeelden van populaire use cases voor webhooks zijn onder andere:

• Het posten van gegevens van HubSpot-contacten naar een ander systeem, zoals een CRM, wanneer dat contact een bepaald formulier op uw site invult.

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

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

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

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

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

Leer meer over webhooks in de developers webhooks documentatie. Als u vragen heeft over uw specifieke implementatie van webhooks met HubSpot, reik dan uit op de HubSpot Developers Forums.

Een webhook in uw workflow instellen

• { local.navWorkflows }}
• Klik op de naam van de workflow.
• Klik op het + icoon om een actie toe te voegen.
• Selecteer in het rechterpaneel Send a webhook (Een webhaak verzenden).
• Klik op het vervolgkeuzemenu Methode en selecteer POST of GET.
• Voer de webhook URL in. Webhook URL's zijn beperkt tot een beveiligd protocol en moeten beginnen met HTTPS. Om specifieke informatie op te vragen, kunt u queryparameters zoals ?queryparameter=abc aan de Webhook URL toevoegen. Als er geen queryparameters zijn toegevoegd, wordt er een algemeen POST- of GET-verzoek verzonden.
• Stel uw authenticatie type in om verzoeken naar uw webhook te authenticeren:
  • Om een verzoekhandtekening te gebruiken in uw webhook-header:
    • Klik op het Authenticatie type dropdown menu. Selecteer vervolgens Include request signature in header.
    • Voer vervolgens uw HubSpot App ID in. Leer hoe u verzoekhandtekeningen kunt verifiëren.

• • U kunt ook een API-sleutel gebruiken voor verificatie. Bij gebruik van een API sleutel voor verificatie, zijn de API sleutel naam en API sleutel locatie die gebruikt worden 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 Type verificatie. 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 u een POST-verzoek instelt, kunt u ervoor kiezen om alle eigenschappen van het CRM-record op te nemen of om alleen specifieke eigenschappen te verzenden:
  • Om alle eigenschappen op te nemen, selecteert u onder de sectie Request body aanpassen, Alle eigenschappen opnemen.
  • Om alleen specifieke eigenschappen op te nemen:
    
    • Selecteer onder de sectie Request body aanpassen de optie Specifieke eigenschappen kiezen.
    • Klik op de Choose property dropdown menu. 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 Property name . Dit zal alleen de property naam in het POST verzoek bijwerken, het zal niet de property naam of interne naam in HubSpot bijwerken.
    • Om een andere property toe te voegen, klik op Add property.
    • Om een eigenschap te verwijderen, klik op het icoon van de verwijder prullenbak
      .
      

• Als u een GET-verzoek instelt, kunt u eigenschappen als queryparameters gebruiken:
  
  • Onder de Query parameters sectie, klik op het Choose property dropdown menu. Klik vervolgens op [object] in deze workflow en selecteer een eigenschap.
  • Om de naam van een eigenschap in de queryparameter te wijzigen, bewerkt u het tekstveld Property name . Dit zal alleen de naam van de eigenschap in het GET-verzoek bijwerken, het zal niet de naam van de eigenschap of de interne naam in HubSpot bijwerken.

• • Om een andere eigenschap toe te voegen, klik op query parameter toevoegen.
  • Om een eigenschap te verwijderen, klik op het verwijder prullenbak icoon.
• Klik op Opslaan.
  
  

Pas uw POST verzoek aan

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

• Als u alle eigenschappen wilt opnemen, selecteert u onder de sectie Request body aanpassen de optie Alle eigenschappen opnemen.
• Om alleen specifieke eigenschappen op te nemen:
  
  • Selecteer onder Customize request body de optie Choose specific properties(Specifieke eigenschappen kiezen).
  • 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 Property name . Dit zal alleen de property naam in het POST verzoek bijwerken, het zal niet de property naam of interne naam in HubSpot bijwerken.
  • Om een andere property toe te voegen, klik op Add property.
  • Om een eigenschap te verwijderen, klik op het verwijder prullenbak icoon
    .
    

Uw GET-verzoeken aanpassen

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

• Klik onder het gedeelte Queryparameters op het vervolgkeuzemenu Kies eigenschap. Klik vervolgens op [object] in deze workflow en selecteer een eigenschap.
• Om de naam van een eigenschap in de queryparameter te wijzigen, bewerkt u het tekstveld Property name . Dit zal alleen de naam van de eigenschap in het GET-verzoek bijwerken, het zal niet de naam van de eigenschap of de interne naam in HubSpot bijwerken.

• Om een andere eigenschap toe te voegen, klik op query parameter toevoegen.
• Om een eigenschap te verwijderen, klik op het icoon van de verwijder prullenbak.
• Klik op Opslaan.
  
  

Test uw webhook binnen HubSpot

Wanneer u uw POST- of GET-webhook instelt, kunt u een test uitvoeren om de webhook-respons te bekijken. Tijdens de test, terwijl gegevens worden verzonden naar en opgehaald van een derde partij, zullen bestaande records in HubSpot niet worden beïnvloed. Als u een API-sleutel gebruikt voor verificatie, wordt de API-sleutel niet weergegeven in testverzoeken.

Na het testen van uw webhook, kunt uselecteren welke velden moeten worden uitgevoerd voor gebruik als invoer later in uw workflow. Selecteer alleen uitgangen die in elke reactie beschikbaar zijn. Als de uitvoer wordt gebruikt in een latere actie maar niet beschikbaar is in de reactie, zal de actie mislukken.

• Klik in het zijpaneel op Testactie om de sectie uit te vouwen.
• Klik op het vervolgkeuzemenu Object en selecteer vervolgens een record om te testen.
• Klik op Test.
• Om de details van de webhook te controleren, selecteert u het tabblad Antwoord of Verzoek. 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 in het tabblad Reactie op headers: of body: om elke sectie uit te vouwen.
  • Klik in het tabblad Request op httpHeaders: om de sectie uit te breiden.
    
    

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 uw workflow is ingeschakeld, kunt u handmatig een testcontact aanmelden.

Als een webhook actie met een POST verzoek wordt getriggerd, zal een JSON response body naar de webhook worden gestuurd met alle informatie over het contact, inclusief formulier inzendingen, lijst lidmaatschappen, en alle contact eigenschap waarden. Het ontvangende systeem kan dan de JSON gegevens parseren, en gebruiken voor zijn eigen toepassing.

Als een webhook actie met een GET verzoek wordt getriggerd, zal een generiek GET verzoek worden verzonden, tenzij aanvullende query parameters zijn toegepast.

Let op: historische eigenschap waarden worden alleen geretourneerd in contact-gebaseerde workflows. Webhooks die in alle andere workflowtypes worden gebruikt, zullen alleen de meest recente waarde terugsturen.

Verzoekhandtekeningen in workflow-webhooks verifiëren

Wanneer u Verzoek handtekening hebt geselecteerd in de sectie Authenticatie voor uw Trigger een webhook actie, zal HubSpot de webhook vullen met een X-HubSpot-Signature header met een SHA-256 hash van de aaneenschakeling van de app-secret voor uw applicatie, de HTTP methode, de URI, en de ongeparsede body. Meer informatie hierover vindt u in de documentatie voor ontwikkelaars.

Om te verifiëren dat de verzoeken ontvangen op uw URL afkomstig zijn van HubSpot:

• Bezit een ontwikkelaarsaccount. Als je er geen hebt, meld je dan aan voor een ontwikkelaarsaccount.
• Bezit een app. Als u geen app hebt, leer dan hoe u een app maakt.
• Controleer de hashwaarde van de handtekening.