Hur man utlöser webhooks i kontaktbaserade arbetsflöden i HubSpot

Sammanfattning

Använd webbhooks i kontaktbaserade arbetsflöden för att skicka eller hämta data mellan HubSpot och dina externa verktyg. Detta gör att du kan automatisera processer mellan olika plattformar. Du kan använda en POST-webhook för att skicka data från HubSpot och en GET-webhook för att hämta data från externa verktyg.

När du konfigurerar dina POST- eller GET-webhooks kan du kontrollera webhooks exekveringshastighet med hastighetsbegränsningar, testa din webhook-konfiguration manuellt i HubSpot eller med externa verktyg.
Du kan också lära dig hur du verifierar förfrågningar från HubSpot, hur du använder webhooks för att starta arbetsflöden automatiskt och hur du använder webhook-svar i andra arbetsflödesåtgärder. 

Läs mer om webhooks i dokumentationen för utvecklare om webhooks. Om du har frågor om din specifika implementering av webhooks med HubSpot kan du kontakta HubSpot Developers Forums.

Vad är några exempel på användningsfall för webhooks?

Exempel på populära användningsfall för webhooks är:

• Publicera HubSpot-kontaktdata till ett annat system, till exempel ett CRM-system, när kontakten fyller i ett visst formulär på din webbplats.

• Skicka affärsuppgifter till ett externt leveranshanteringssystem för att skapa en inköpsorder.

• Hämta data från ett annat system för att uppdatera dina HubSpot-poster.

Du kan skicka både POST- och GET-förfrågningar med hjälp av arbetsflöden. HubSpot reglerar webhook-trafik separat från andra arbetsflödesprocesser. Detta görs för att effektivisera arbetsflödet och webhook-prestandan. När en webhook är långsam eller går ut kan det ta längre tid än väntat att utföra arbetsflödesåtgärden.

Hur skickar jag data från HubSpot med hjälp av en POST-webhook?

1. I ditt HubSpot-konto navigerar du till Automatisering > Arbetsflöden.
2. För att redigera ett befintligt arbetsflöde klickar du på namnet på arbetsflödet. Eller skapa ett nytt arbetsflöde.
3. I arbetsflödesredigeraren klickar du på plusikonen + för att lägga till en åtgärd.
4. I den vänstra panelen, i avsnittet Dataops, väljer du Skicka en webhook.
    

5. Klicka på rullgardinsmenyn Metod och välj POST.
6. Ange webhook-URL:en.
   • Webhook-URL:er är begränsade till ett säkert protokoll och måste börja med HTTPS.
   • För att begära specifik information kan du lägga till frågeparametrar som ?queryparameter=abc till webhook-URL:en .
   • Om inga frågeparametrar har lagts till skickas en generisk POST- eller GET-begäran.
7. Konfigurera din autentiseringstyp för att autentisera förfrågningar till din webhook. Du kan antingen använda en förfrågningssignatur i din webhook-rubrik eller använda en API-nyckel:
   • Så här använder du en begäran-signatur i din webhook-rubrik:
     • Klicka på rullgardinsmenyn Autentiseringstyp. Välj sedan Inkludera förfrågningssignatur i rubriken.
     • Ange sedan ditt HubSpot-app-ID. Läs om hur du verifierar begäran-signaturer.
   • Så här använder du en API-nyckel eller en offentlig app som skapats via ett utvecklarkonto för autentisering:
     • När du använder en API-nyckel för autentisering beror API-nyckelnamnet och API-nyckelplatsen på hur webhooken är konfigurerad. Av säkerhetsskäl visas API-nyckeln inte i några testförfrågningar. Så här använder du en API-nyckel:
       • Klicka på rullgardinsmenyn Autentiseringstyp. Välj sedan API-nyckel.
       • Ange ditt API-nyckelnamn.
       • Klicka på rullgardinsmenyn API-nyckelns plats. Välj sedan antingen Frågeparametrar eller Begäranrubrik. Läs mer om hur du använder API-nycklar i HubSpot.
     • Om du gör en begäran till HubSpot API:er:
       • Klicka på rullgardinsmenyn API-nyckel och välj en hemlighet. Hemlighetsvärdet måste ha formatet Bearer [YOUR_TOKEN].
       • Ställ in värdet för API-nyckelnamnet till Authorization.
       • Ställ in värdet för API-nyckelns plats till Begäranrubrik.
8. Om du vill inkludera alla egenskaper väljer du Inkludera alla [objekt]egenskaper.
9. Om du endast vill inkludera specifika egenskaper:
   • Välj Anpassa begäran.
   • Om du vill anpassa begäranstexten med hjälp av en HubSpot-egenskap anger du nyckeln och väljer en egenskap. Om du vill lägga till en annan egenskap klickar du på Lägg till egenskap.
   • Om du vill anpassa begäranstexten med ett statiskt fält anger du nyckeln och värdet. Om du vill lägga till en annan egenskap klickar du på Lägg till statiskt värde.
   • Om du vill ta bort en egenskap eller ett statiskt värde klickar du på papperskorgsikonen.
10. Klicka på Spara längst upp.

Observera: för att välja flera utdata bör svaret struktureras som ett JSON-objekt.

Hur hämtar jag data till HubSpot med hjälp av en GET-webhook?

1. I ditt HubSpot-konto navigerar du till Automatisering > Arbetsflöden.
2. För att redigera ett befintligt arbetsflöde klickar du på namnet på arbetsflödet. Eller skapa ett nytt arbetsflöde.
3. I arbetsflödesredigeraren klickar du på plusikonen (+) för att lägga till en åtgärd.
4. I den vänstra panelen, i avsnittet Dataops, väljer du Skicka en webhook.
    

5. Klicka på rullgardinsmenyn Metod och välj GET.
6. Ange webhook-URL:en.
   • Webhook-URL:er är begränsade till ett säkert protokoll och måste börja med HTTPS.
   • För att begära specifik information kan du lägga till frågeparametrar som ?queryparameter=abc till webhook-URL:en .
   • Om inga frågeparametrar har lagts till skickas en generisk POST- eller GET-begäran.
7. Konfigurera din autentiseringstyp för att autentisera förfrågningar till din webhook. Du kan antingen använda en förfrågningssignatur i din webhook-rubrik eller använda en API-nyckel:
   • Så här använder du en begäran-signatur i din webhook-rubrik:
     • Klicka på rullgardinsmenyn Autentiseringstyp. Välj sedan Inkludera förfrågningssignatur i rubriken.
     • Ange sedan ditt HubSpot-app-ID. Läs om hur du verifierar begäran-signaturer.
   • Så här använder du en API-nyckel eller en offentlig app som skapats via ett utvecklarkonto för autentisering:
     • När du använder en API-nyckel för autentisering beror API-nyckelnamnet och API-nyckelplatsen på hur webhooken är konfigurerad. Av säkerhetsskäl visas API-nyckeln inte i några testförfrågningar. Så här använder du en API-nyckel:
       • Klicka på rullgardinsmenyn Autentiseringstyp. Välj sedan API-nyckel.
       • Ange ditt API-nyckelnamn.
       • Klicka på rullgardinsmenyn API-nyckelns plats. Välj sedan antingen Frågeparametrar eller Begäranrubrik. Läs mer om hur du använder API-nycklar i HubSpot.
     • Om du gör en begäran till HubSpot API:er:
       • Klicka på rullgardinsmenyn API-nyckel och välj en hemlig kod. Den hemliga koden måste ha formatet Bearer [DIN_TOKEN].
       • Ställ in värdet för API-nyckelnamnet till Authorization.
       • Ställ in värdet för API-nyckelns plats till Begäranrubrik.
8. Om du konfigurerar en GET-begäran kan du antingen använda HubSpot-egenskaper eller lägga till statiska värden som frågeparametrar: 

9. Så här använder du en HubSpot-egenskap som frågeparameter:
   • Under avsnittet Frågeparametrar anger du nyckeln och väljer sedan en egenskap.
   • För att lägga till en annan egenskap klickar du på Lägg till egenskap.
   • Om du vill ta bort en egenskap klickar du på ikonen Radera .
10. Så här använder du ett statiskt värde som en frågeparameter:
    • Under avsnittet Frågeparametrar anger du nyckeln och sedan ett värde.
    • För att lägga till en annan egenskap, klicka på Lägg till statiskt värde.
    • För att ta bort en egenskap, klicka på ikonen för borttagning.
11. Klicka på Spara.

Hur kontrollerar jag webhooks exekveringshastighet med hastighetsbegränsningar?

Ställ in en hastighetsbegränsning för att bestämma hur snabbt webhook-åtgärden ska exekveras. Hastighetsbegränsningen påverkar även alla efterföljande åtgärder i arbetsflödet.

1. I ditt HubSpot-konto navigerar du till Automatisering > Arbetsflöden.
2. Klicka på namnet på arbetsflödet.
3. I arbetsflödesredigeraren klickar du på åtgärden Skicka en webhook.
4. Klicka på Konfigurera hastighetsbegränsningi den vänstra panelen för att expandera avsnittet.
5. Klicka för att aktivera växeln Aktivera hastighetsbegränsning. Som standard är denna inställning inaktiverad. 
6. Ställ in din hastighetsbegränsning: 
   • Åtgärdsutförande: ställ in maximalt antal utföranden per tidsperiod. 
   • Tidsram: ställ in tidsramen för din hastighetsbegränsning. Du kan ställa in denna tidsram i sekunder, minuter eller timmar. 

Hur testar jag min webhook-konfiguration i HubSpot?

När du konfigurerar din POST- eller GET-webhook kan du utföra ett test för att se webhook-svaret. Under testet, medan data skickas till och hämtas från en tredje part, påverkas inte befintliga poster i HubSpot. Om du använder en API-nyckel för autentisering visas API-nyckeln inte i några testförfrågningar.

Efter att ha testat din webhook kan du välja vilka fält som ska matas ut för att användas som indata senare i ditt arbetsflöde. Välj endast utdata som är tillgängliga i varje svar. Om utdata används i en senare åtgärd men inte är tillgänglig i svaret kommer åtgärden att misslyckas.

1. I ditt HubSpot-konto navigerar du till Automatisering > Arbetsflöden.
2. Klicka på namnet på arbetsflödet.
3. I arbetsflödesredigeraren klickar du på åtgärden Skicka en webhook.
4. Klicka på Testa åtgärd i den vänstra panelen för att expandera avsnittet.
5. Om du testar en POST-begäran kommer inställningen av webhook-testet att skilja sig beroende på om du har valt att anpassa begäran eller inkludera alla [objekt]egenskaper i webhook-åtgärden.
   • Om du har valt Anpassa begäran, ange egenskapstestvärdena för ditt test.
   • Om du har valt Inkludera alla [objekt]egenskaper klickar du på rullgardinsmenyn [objekt] och väljer sedan en post att testa med.
6. Klicka på Testa.
7. För att kontrollera webhook-informationen väljer du fliken Svar eller Begäran. På varje flik kan du klicka på Öppna alla för att expandera alla avsnitt eller Dölj alla för att dölja alla avsnitt.
   • På fliken Svar klickar du på rubriker: eller kropp: för att expandera varje avsnitt.
   • På fliken Begäran klickar du på httpHeaders: för att expandera avsnittet.
     
     

Hur testar jag webbhooks med externa verktyg?

När du har skapat ditt arbetsflöde med en webbhook-åtgärd kan du köra ett snabbtest med en dummy-webbhook-URL:

1. Gå till https://webhook.site i din webbläsare och kopiera den unika URL:en.
2. Klistra in URL:en i fältet Webhook-URL i din webhook-åtgärd.
3. När ditt arbetsflöde har aktiverats kan du manuellt registrera en testkontakt.
4. När du testar din webhook externt:
   • Om en webhook-åtgärd med en POST-begäran utlöses skickas ett JSON-svar till webhooken som innehåller all information om kontakten, inklusive formulärinlämningar, listmedlemskap och alla kontaktens egenskapsvärden. Det mottagande systemet kan sedan analysera JSON-data och använda den för sin egen applikation.
   • Om en webhook-åtgärd med en GET-begäran utlöses skickas en generisk GET-begäran, såvida inte ytterligare frågeparametrar har tillämpats.

Observera: historiska egenskapsvärden returneras endast i kontaktbaserade arbetsflöden. Webhooks som används i alla andra typer av arbetsflöden returnerar endast det senaste värdet.

Hur verifierar jag att webhook-förfrågningar kommer från HubSpot?

Om du har valt Begär signatur i avsnittet Autentisering för din Trigga en webhook-åtgärd kommer HubSpot att fylla webhooken med en X-HubSpot-Signature-rubrik med en SHA-256-hash av sammanfogningen av app-secret för din applikation, HTTP-metoden, URI och den oparsade kroppen. Läs mer om detta i dokumentationen för utvecklare.

Så här verifierar du att förfrågningarna som tas emot på din URL kommer från HubSpot:

• Ha ett utvecklarkonto. Om du inte har ett, registrera dig för ett utvecklarkonto.
• Ha en app. Om du inte har en app kan du läsa om hur du skapar en app.
• Kontrollera signaturens hashvärde.

Hur använder jag webhooks för att starta arbetsflöden automatiskt?

Webhooks kan användas för att utlösa arbetsflöden. När data ändras i en tredjepartsapp kan detta utlösa ett arbetsflöde. Läs mer om att utlösa arbetsflöden från webhooks.

Hur använder jag webbhook-svar i andra arbetsflödesåtgärder?

Data från webbhooken som är ansluten till ditt konto kan användas för vissa åtgärder i datapanelen.

Så här använder du data från den anslutna webbhooken:

1. I ditt HubSpot-konto navigerar du till Automatisering > Arbetsflöden.
2. Klicka på namnet på ditt arbetsflöde.
3. Klicka på plusikonen + för att lägga till en åtgärd.
4. I den vänstra panelen väljer du en åtgärd som använder datapanelen.
5. I datapanelen, under Åtgärdsdata, väljer du din Skicka en webhook-åtgärd. Du kan sedan använda egenskaper från den anslutna webhooken.
    

Vad händer när en webhook misslyckas?

HubSpot försöker igen med misslyckade webhooks i upp till tre dagar, med start en minut efter misslyckandet. Efterföljande misslyckanden försöks igen med ökande intervall, med ett maximalt intervall på åtta timmar mellan försöken.

Arbetsflöden försöker inte igen efter att ha fått svarstatuskoder i 4XX-serien. Undantaget är 429-fel för hastighetsbegränsning. Arbetsflöden försöker automatiskt igen efter att ha fått ett 429-svar och respekterar Retry-After-rubriken om den finns. Retry-After registreras i millisekunder. Läs mer om specifika undantag för felkoder i HubSPots utvecklardokumentation.