Använd webhooks med HubSpot-arbetsflöden

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ändningsområden för webhooks inkluderar:

• Skicka HubSpot-kontaktdata till ett annat system, t.ex. ett CRM-system, när den kontakten fyller i ett visst formulär på din webbplats.

• Skicka affärsdata till ett externt system för hantering av leveranser för att skapa en inköpsorder.

• Skicka chattvarningar från ditt externa system till företagets chattflöde för att meddela anställda att något viktigt har inträffat.

• 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 tar timeout kan det ta längre tid än förväntat att utföra arbetsflödesåtgärden.

Observera: HubSpot gör nya försök med misslyckade webhooks i upp till tre dagar, med start en minut efter misslyckandet. Efterföljande misslyckanden kommer att försökas igen 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 i 4XX-serien.
Ett undantag till denna regel är 429 rate limit-fel; arbetsflöden kommer automatiskt att försöka igen efter att ha mottagit ett 429-svar, och kommer att respektera Retry-After-headern om den finns. Retry-After registreras i milisekunder. Läs mer om specifika undantag för felkoder i HubSpots dokumentation för utvecklare.

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

Konfigurera en webhook i ditt arbetsflöde

• I ditt HubSpot-konto navigerar du till Automatiseringar > Arbetsflöden.
• Klicka på arbetsflödets namn .
• Klicka på ikonen + för att lägga till en åtgärd.
• Välj Skicka en webhook i den vänstra panelen.
• Klicka på rullgardinsmenyn Metod och välj POST eller GET.
• Ange webbhookens URL. 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:
  • Så här använder du en begärandesignatur i webhook-rubriken:
    • Klicka på rullgardinsmenyn Autentiseringstyp. Välj sedan Inkludera begärandesignatur i rubrik.
    • Ange sedan ditt HubSpot App-ID. Läs mer om hur du verifierar begärandesignaturer.

• • Du kan också använda en API-nyckel eller en offentlig app som skapats via ett utvecklarkonto för autentisering.

Observera: Från och med den 30 november 2022 är HubSpot API-nycklar för åldrade och stöds inte längre. Du kan fortfarande använda externa API-nycklar för autentisering i HubSpot-arbetsflöden.

• • • När en API-nyckel används för autentisering beror API-nyckelns namn och plats 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 Autentiseringstyp. Välj sedan API-nyckel.

• • • • Ange namnet på din API-nyckel.
      • Klicka på API-nyckelns plats i rullgardinsmenyn. 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 en av våra 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].
      • Ange värdet för API-nyckelns namn till Auktorisering.
      • Ange värdet för API-nyckelns plats till Request Header.
• Om du konfigurerar en POST-begäran kan du välja att inkludera alla egenskaper från CRM-posten eller att bara skicka specifika egenskaper:
  • Om du vill inkludera alla egenskaper väljer du Inkludera alla egenskaper i avsnittet Anpassa begärandets kropp.
  • Om du bara vill inkludera specifika egenskaper:
    
    • Välj Välj specifika egenskaper under avsnittet Anpassa begäran.
    • Klicka på rullgardinsmenyn Välj egenskap. Klicka sedan på [objekt] i det här arbetsflödet och välj en egenskap.
    • Om du vill ändra en egenskaps namn i webhooken redigerar du textfältet Egenskapsnamn . Detta kommer endast att uppdatera egenskapsnamnet i POST-begäran, det kommer inte att uppdatera egenskapsnamnet eller det interna namnet i HubSpot.
    • 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å ikonen för papperskorgen delete.
      

• Om du konfigurerar en GET-begäran kan du använda egenskaper som frågeparametrar:
  
  • Under avsnittet Frågeparametrar klickar du på rullgardinsmenyn Välj egenskap. Klicka sedan på [objekt] i det här arbetsflödet och välj en egenskap.
  • Om du vill ändra en egenskaps namn i frågeparametern redigerar du textfältet Egenskapsnamn . Detta kommer endast att uppdatera egenskapsnamnet i GET-begäran, det kommer inte att uppdatera egenskapsnamnet eller det interna namnet i HubSpot.
  • Om du vill lägga till en annan egenskap klickar du på Lägg till frågeparameter.
  • Om du vill ta bort en egenskap klickar du på ikonen för papperskorgen delete.
• Klicka på Spara.
  
  

Observera: för att välja flera utdata ska svaret vara strukturerat som ett JSON-objekt.

Anpassa din POST-förfrågan

Om du konfigurerar en POST-begäran kan du välja att inkludera alla egenskaper från CRM-posten eller att bara skicka specifika egenskaper:

• Om du vill inkludera alla egenskaper väljer du Inkludera alla egenskaper i avsnittet Anpassa begärandets kropp.
• Att endast inkludera specifika egenskaper:
  
  • Välj Anpassa förfrågningstext under avsnittet Förfrågningstext.
  • Ange nyckel och värde.
  • Om du vill ändra en egenskaps namn i webhooken redigerar du textfältet Nyckel . Detta kommer endast att uppdatera egenskapsnamnet i POST-begäran, det kommer inte att uppdatera egenskapsnamnet eller det interna namnet i HubSpot.
  • 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 delete.
    
    

Anpassa dina GET-förfrågningar

Om du konfigurerar en GET-begäran kan du använda egenskaper som frågeparametrar för att hämta specifika data:

• Under avsnittet Förfrågningsparametrar anger du Nyckeln och väljer sedan en fastighet.
• För att ändra en egenskaps namn i frågeparametern, redigera textfältet Egenskapsnamn . Detta kommer endast att uppdatera egenskapsnamnet i GET-begäran, det kommer inte att uppdatera egenskapsnamnet eller det interna namnet i HubSpot.
• 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å ikonen delete papperskorg.
• Välj en autentiseringstyp från rullgardinsmenyn.
• Klicka på Spara.
  
  

Testa din webhook i HubSpot

När du konfigurerar din POST- eller GET-webhook kan du utföra ett test för att visa webhook-svaret. Under testet skickas data till och hämtas från en tredje part, men befintliga poster i HubSpot kommer 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å Teståtgärd i sidopanelen för att expandera avsnittet.
• Klicka på rullgardinsmenyn Objekt och välj 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 Dölj alla för att dölja alla avsnitt.
  
  • Klicka på Headers: eller Body: på fliken Svar om du vill expandera varje avsnitt.
  • Klicka på httpHeaders: på fliken Begäran 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 snabbtest med en dummy-webhook-URL:

• Gå till https://webhook.site i din webbläsare och kopiera den unika webbadressen.
• Klistra in URL:en i fältet Webhook URL i din webhook-åtgärd.

• När arbetsflödet har aktiverats kan du manuellt registrera en testkontakt.

Om en webhook-åtgärd med en POST-förfrågan utlöses skickas en JSON-svarskropp 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 dem i sin egen applikation.

Om en webhook-åtgärd med en GET-förfrågan utlöses kommer en generisk GET-förfrågan att skickas, om inte ytterligare frågeparametrar har tillämpats.

Observera: historiska fastighetsvä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 begärandesignaturer i webhooks för arbetsflöden

Om du har valt Begär signatur i avsnittet Autentisering för din åtgärd Trigger a webhook, kommer HubSpot att fylla webhooken med en X-HubSpot-Signature header med en SHA-256-hash av konkateneringen av app-secret för din applikation, HTTP-metoden, URI och den oparerade 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:

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

Utlösa arbetsflöden från webhooks

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

Använda webhook-data i datapanelen

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

För att använda data från den anslutna webhooken:

• I ditt HubSpot-konto navigerar du till Automatiseringar > Arbetsflöden.
• 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, under Anmälningsegenskaper kan du välja en av egenskaperna från den anslutna webhooken.