Använd webhooks i arbetsflöden för att skicka eller hämta information mellan HubSpot och andra externa verktyg. Det finns en mängd olika användningsområden för webhooks, exempel på populära användningsfall för webhooks inkluderar:
-
Posta HubSpot-kontaktdata till ett annat system, till exempel ett CRM, när kontakten fyller i ett visst formulär på din webbplats.
-
Skicka affärsdata 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-trafiken separat från andra arbetsflödesprocesser. Detta görs för att effektivisera arbetsflödet och webhookens prestanda. När en webhook är långsam eller tidsbegränsad kan det ta längre tid än förväntat att utföra arbetsflödesåtgärden.
Observera: HubSpot kommer att försöka igen misslyckade webhooks i upp till tre dagar, med början en minut efter misslyckandet. Efterföljande misslyckanden kommer att prövas på nytt med ökande intervall, med ett maximalt gap på åtta timmar mellan försöken. Arbetsflöden försöker inte igen efter att ha fått statuskoder för svar i 4XX-serien.
Ett undantag från denna regel är 429 rate limit errors; arbetsflöden kommer automatiskt att försöka igen efter att ha mottagit ett 429-svar och kommer att respektera Retry-After-huvudet om det finns. Retry-After registreras i milisekunder. Läs mer om specifika felkodsundantag i HubSpots utvecklardokumentation.
Läs mer om webhooks i utvecklarnas webhooks-dokumentation. Om du har frågor om din specifika implementering av webhooks med HubSpot, kontakta oss på HubSpot Developers Forums.
Ställ in en POST-begäran
- Om du vill redigera ett befintligt arbetsflöde klickar du på arbetsflödets namn. Du kan också skapa ett nytt arbetsflöde.
- Klicka på + plus-ikonen i arbetsflödesredigeraren för att lägga till en åtgärd.
- I den vänstra panelen, i avsnittet Data ops, väljer du Skicka en webhook.
- Klicka på rullgardinsmenyn Metod och välj POST.
- Ange webbadressen till webhooken.
- Webhook-URL:er är begränsade till ett säkert protokoll och måste börja med HTTPS.
- Om du vill begära specifik information kan du lägga till frågeparametrar som
?queryparameter=abc i Webhook-URL:en.
- Om inga frågeparametrar har lagts till skickas en generisk POST- eller GET-begäran.
- Ställ in din autentiseringstyp för att autentisera förfrågningar till din webhook. Du kan antingen använda en begärandesignatur i webhook-headern eller använda en API-nyckel:
- Så här använder du en begärandesignatur i webhookens rubrik:
- Klicka på rullgardinsmenyn Autentiseringstyp. Välj sedan Inkludera begärandesignatur i rubriken.
- Ange sedan ditt HubSpot App ID. Läs mer om hur du verifierar begärandesignaturer.
-
- För att använda 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 namnet på API-nyckeln och platsen för API-nyckeln på hur webhooken är konfigurerad. Av säkerhetsskäl kommer API-nyckeln inte att visas i några testförfrågningar. Så här använder du en API-nyckel:
- Klicka på rullgardinsmenyn Authentication type. Välj sedan API-nyckel.
-
-
-
- Ange namnet på din API-nyckel.
- Klicka på rullgardinsmenyn API-nyckelns plats. Välj sedan antingen Query parameters eller Request header. Läs mer om hur du använder API-nycklar i HubSpot.
- Om du gör en förfrågan till HubSpot API:er:
- Klicka på rullgardinsmenyn API-nyckel och välj en hemlighet. Det hemliga värdet måste vara i formatet Bearer [YOUR_TOKEN].
- Ställ in värdet för API-nyckelns namn till Authorization.
- Ställ in värdet för API-nyckelns plats till Request Header.
- Om du vill inkludera alla egenskaper väljer du Include all [object] properties.
- Om du bara vill inkludera specifika egenskaper:
- Välj Customize request body.
- Om du vill anpassa begäran 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äran med hjälp av ett statiskt fält anger du nyckel och värde. 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 på delete.
- Klicka på Save (Spara).
Observera: Om du vill välja flera utgångar ska svaret struktureras som ett JSON-objekt.
Konfigurera en GET-begäran
- Om du vill redigera ett befintligt arbetsflöde klickar du på arbetsflödets namn. Du kan också skapa ett nytt arbetsflöde.
- Klicka på + plus-ikonen i arbetsflödesredigeraren för att lägga till en åtgärd.
- I den vänstra panelen, i avsnittet Data ops, väljer du Skicka en webhook.
- Klicka på rullgardinsmenyn Metod och välj GET.
- Ange webbadressen till webhooken.
- Webhook-URL:er är begränsade till ett säkert protokoll och måste börja med HTTPS.
- Om du vill begära specifik information kan du lägga till frågeparametrar som
?queryparameter=abc i Webhook-URL:en.
- Om inga frågeparametrar har lagts till skickas en generisk POST- eller GET-begäran.
- Ställ in din autentiseringstyp för att autentisera förfrågningar till din webhook. Du kan antingen använda en begärandesignatur i webhook-headern eller använda en API-nyckel:
- Så här använder du en begärandesignatur i webhookens rubrik:
- Klicka på rullgardinsmenyn Autentiseringstyp. Välj sedan Inkludera begärandesignatur i rubriken.
- Ange sedan ditt HubSpot App ID. Läs mer om hur du verifierar begärandesignaturer.
-
- För att använda 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 namnet på API-nyckeln och platsen för API-nyckeln på hur webhooken är konfigurerad. Av säkerhetsskäl kommer API-nyckeln inte att visas i några testförfrågningar. Så här använder du en API-nyckel:
- Klicka på rullgardinsmenyn Authentication type. Välj sedan API-nyckel.
-
-
-
- Ange namnet på din API-nyckel.
- Klicka på rullgardinsmenyn API-nyckelns plats. Välj sedan antingen Query parameters eller Request header. Läs mer om hur du använder API-nycklar i HubSpot.
- Om du gör en förfrågan till HubSpot API:er:
- Klicka på rullgardinsmenyn API-nyckel och välj en hemlighet. Det hemliga värdet måste vara i formatet Bearer [YOUR_TOKEN].
- Ställ in värdet för API-nyckelns namn till Authorization.
- Ställ in värdet för API-nyckelns plats till Request Header.
Om du skapar en GET-begäran kan du antingen använda HubSpot-egenskaper eller lägga till statiska värden som frågeparametrar:
- Så här använder du en HubSpot-egenskap som en frågeparameter:
- Under avsnittet Frågeparametrar anger du nyckeln och väljer sedan en egenskap.
- Om du vill lägga till en annan egenskap klickar du på Lägg till egenskap.
- Om du vill ta bort en egenskap klickar du på papperskorgsikonen på delete.
- Så här använder du ett statiskt värde som frågeparameter:
- I avsnittet Query parameters anger du Key och sedan ett värde.
- Om du vill lägga till en annan egenskap klickar du på Add static value.
- Om du vill ta bort en egenskap klickar du på papperskorgsikonen delete.
- Klicka på Spara.
Testa din webhook inom HubSpot
När du konfigurerar din POST- eller GET-webhook kan du utföra ett test för att visa webhook-svaret. Under testet, medan data skickas till och hämtas från en tredje part, kommer befintliga poster i HubSpot inte att påverkas. Om du använder en API-nyckel för autentisering kommer API-nyckeln inte att visas i några testförfrågningar.
När du har 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.
- Klicka på arbetsflödets namn.
- I arbetsflödesredigeraren klickar du på åtgärden Skicka en webhook.
- Klicka på Teståtgärd i den vänstra panelen för att expandera avsnittet.
- Om du testar en POST-begäran klickar du på rullgardinsmenyn [objekt] och väljer sedan en post att testa med.
- Klicka på Test.
- Om du vill kontrollera webhook-detaljerna väljer du fliken Svar eller Begäran. På varje flik kan du klicka på Öppna alla för att expandera alla avsnitt, eller på Dölj alla för att kollapsa alla avsnitt.
- Klicka på headers : eller body : på fliken Response för att expandera varje avsnitt.
- På fliken Request klickar du på httpHeaders : för att expandera avsnittet.
Testa din webhook externt
När du har skapat ditt arbetsflöde med en webhook-åtgärd kan du köra ett snabbt test med en dummy-webhook-URL:
- När du testar din webhook externt:
- Om en webhook-åtgärd med en POST-begäran utlöses skickas en JSON-svarskropp till webhooken som innehåller all information om kontakten, inklusive formulärinlämningar, listmedlemskap och alla kontaktegenskapsvärden. Det mottagande systemet kan sedan analysera JSON-data och använda dem i sin egen applikation.
- Om en webhook-åtgärd med en GET-begäran utlöses kommer en generisk GET-begäran att skickas, om inte ytterligare frågeparametrar har använts.
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.
Verifiera signaturer för förfrågningar i webhooks för arbetsflöden
Om du har valt Begärandesignatur i avsnittet Autentisering för din Trigger a webhook-åtgärd kommer HubSpot att fylla i webhooken med en X-HubSpot-Signature-rubrik med en SHA-256-hash av sammankopplingen av app-sekretessen för din applikation, HTTP-metoden, URI och den oanalyserade kroppen. Läs mer om detta i dokumentationen för utvecklare.
För att verifiera att de förfrågningar som tas emot på din URL kommer från HubSpot:
Utlösa arbetsflöden från webhooks
Webhooks kan användas för att trigga arbetsflöden. När data ändras i en app från tredje part kan detta utlösa ett arbetsflöde. Läs mer om hur du utlöser arbetsflöden från webhooks.
Använd webhook-data i datapanelen
Data från den webhook 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 webhooken:
- Klicka på namnet på ditt arbetsflöde.
- Klicka på + plus-ikonen för att lägga till en åtgärd.
- I den vänstra panelen väljer du en åtgärd som använder datapanelen.
- I datapanelen klickar du på rullgardinsmenyn Visa egenskaper eller åtgärdsutgångar från och väljer Webhook-trigger. Du kan sedan använda egenskaper från den anslutna webhooken.