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 är:

• Skicka HubSpot-uppgifter om kontakter 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 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-begäranden med hjälp av arbetsflöden. HubSpot reglerar webhook-trafiken separat från andra arbetsflödesprocesser. Detta görs för att effektivisera arbetsflöden och prestanda för webhooks. När en webhook är långsam eller tar tid kan arbetsflödesåtgärden ta längre tid än väntat att utföra.

Observera: HubSpot försöker 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 intervall på åtta timmar mellan försöken. Läs mer om specifika undantag för felkoder i HubSpots dokumentation för utvecklare.

Läs mer om webhooks i dokumentationen om 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, navigera till Automatisering > Arbetsflöden.
• Klicka på arbetsflödets namn .
• Klicka på ikonen + för att lägga till en åtgärd.
• I den högra panelen väljer du Skicka en webhook.
• Klicka på rullgardinsmenyn Metod och välj POST eller GET.
• Ange webhook-URL:n. 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 webbhook-URL:n. Om inga frågeparametrar har lagts till skickas en generisk POST- eller GET-förfrågan.
• Konfigurera din autentiseringstyp för att autentisera förfrågningar till din webhook:
  • Om du vill använda en signatur för begäran i din webhook-huvudrubrik: Använd en signatur för begäran i din webhook-huvudrubrik:
    • Klicka på rullgardinsmenyn Autentiseringstyp. Välj sedan Inkludera signatur för begäran i rubriken.
    • Ange sedan ditt HubSpot App ID. Läs mer om hur du verifierar signaturer för begäran.

• • 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 har HubSpot API-nycklar avvecklats och stöds inte längre. Du kan fortfarande använda externa API-nycklar för autentisering i HubSpot-arbetsflöden.

• • • När du använder en API-nyckel för autentisering beror API-nyckelns namn och API-nyckelplats på hur webhooken är konfigurerad. Av säkerhetsskäl kommer API-nyckeln inte att visas i några testförfrågningar. Användning av en API-nyckel:
      • Klicka på rullgardinsmenyn Autentiseringstyp. Välj sedan API-nyckel.

• • • • Ange namnet på din API-nyckel.
      • Klicka på rullgardinsmenyn API-nyckelplats. Välj sedan antingen Förfrågeparametrar eller Förfrågningshuvud. Läs mer om hur du använder API-nycklar i HubSpot.
    • Om du gör en begäran till ett 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].
      • Ställ in värdet för API-nyckelns namn till Auktorisering.
      • Ställ in värdet för API-nyckelns plats till Request Header.
• Om du ställer in en POST-förfrågan kan du välja att inkludera alla egenskaper från CRM-posten eller att skicka endast specifika egenskaper:
  • Om du vill inkludera alla egenskaper väljer du Inkludera alla egenskaper under avsnittet Anpassa begärandekroppen.
  • Om du bara vill inkludera specifika egenskaper:
    
    • Välj Välj specifika egenskaper under avsnittet Anpassa begärandekroppen.
    • 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 Egendomsnamn . Detta kommer endast att uppdatera egenskapsnamnet i POST-förfrågan, 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 ställer in en GET-begäran kan du använda egenskaper som frågeparametrar:
  
  • Klicka på rullgardinsmenyn Välj egenskap under avsnittet Förfrågningsparametrar . 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 Egendomsnamn . Detta kommer endast att uppdatera egenskapsnamnet i GET-förfrågan, 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 utgångar ska svaret vara strukturerat som ett JSON-objekt.

Anpassa din POST-förfrågan

Om du ställer in en POST-förfrågan kan du välja att inkludera alla egenskaper från CRM-posten eller att skicka endast specifika egenskaper:

• Om du vill inkludera alla egenskaper väljer du Inkludera alla egenskaper i avsnittet Anpassa begärandekroppen.
• Om du bara vill inkludera specifika egenskaper:
  
  • Under avsnittet Förfrågningskropp väljer du Anpassa förfrågningskroppen.
  • Ange nyckel och värde.
  • Om du vill ändra en egenskaps namn i webhooken redigerar du textfältet Key (nyckel) . Detta kommer endast att uppdatera egenskapsnamnet i POST-förfrågan, 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å delete papperskorvsikonen.
    
    

Anpassa dina GET-förfrågningar

Om du ställer in 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 egenskap.
• Om du vill ändra en egenskaps namn i frågeparametern redigerar du textfältet Egendomsnamn . Detta uppdaterar endast fastighetsnamnet i GET-förfrågan, inte fastighetsnamnet 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.
• 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 se svaret på webhooken. Under testet skickas data till och hämtas från en tredje part, men befintliga poster i HubSpot påverkas inte. 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 skickas ut för att användas som indata senare i arbetsflödet. Välj endast utgångar som är tillgängliga i varje svar. Om utmatningen används i en senare åtgärd men inte är tillgänglig i svaret misslyckas åtgärden.

• I sidopanelen klickar du på Testa åtgärd för att utöka avsnittet.
• Klicka på rullgardinsmenyn Objekt och välj sedan en Record att testa med.
• Klicka på Test.
• Om du vill kontrollera detaljerna om webhooken väljer du fliken Svar eller begäran. På varje flik kan du klicka på Öppna alla för att expandera alla sektioner eller på Kolla alla för att kollapsa alla sektioner.
  
  • På fliken Svar klickar du på headers: eller body: för att expandera varje avsnitt.
  • På fliken Begäran 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 snabbtest med en dummywebhook-URL:

• Navigera till https://webhook.site i din webbläsare och kopiera den unika webbadressen.
• Klistra in URL-adressen 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ärsändningar, listmedlemskap och alla värden för kontaktegenskaper. Det mottagande systemet kan sedan analysera JSON-data och använda den i sin egen applikation.

Om en webhook-åtgärd med en GET-förfrågan utlöses skickas en generisk GET-förfrågan, om 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.

Verifiera begäranssignaturer i webhooks för arbetsflöden

Om du har valt Begärningssignatur i avsnittet Autentisering för åtgärden Utlösa en webhook kommer HubSpot att fylla webhooken med en X-HubSpot-Signature-huvud med en SHA-256-hash av sammanställningen av app-sekret för ditt program, HTTP-metoden, URI:n och den oparserade kroppen. Läs mer om detta i dokumentationen för utvecklare.

För att kontrollera att de förfrågningar som tas emot på din URL kommer från HubSpot:

• Äga ett utvecklarkonto. Om du inte har något, registrera dig för ett utvecklarkonto.
• Äga en app. Om du inte har någon app, lär dig hur man skapar en app.
• Kontrollera signaturens hashvärde.