Vidensbase

Brug webhooks med HubSpot-arbejdsgange

Skrevet af HubSpot Support | Jun 28, 2023 12:41:26 PM

Brug webhooks i workflows til at sende eller hente information mellem HubSpot og andre eksterne værktøjer. Der er mange forskellige anvendelsesmuligheder for webhooks, og eksempler på populære anvendelser af webhooks omfatter:

  • Udsendelse af HubSpot-kontaktdata til et andet system, f.eks. et CRM-system, når kontakten udfylder en bestemt formular på dit website.

  • Afsendelse af aftaledata til et eksternt forsendelseshåndteringssystem for at oprette en indkøbsordre.

  • Hentning af data fra et andet system for at opdatere dine HubSpot-poster.

Du kan sende både POST- og GET-anmodninger ved hjælp af workflows. HubSpot regulerer webhook-trafikken separat fra andre workflow-processer. Dette gøres for at strømline workflow- og webhook-performance. Når en webhook er langsom eller går i stå, kan det tage længere tid end forventet at udføre workflow-handlingen.

Bemærk: HubSpot vil prøve mislykkede webhooks igen i op til tre dage, startende et minut efter fejlen. Efterfølgende fejl vil blive forsøgt igen med stigende intervaller, med et maksimalt mellemrum på otte timer mellem forsøgene. Workflows prøver ikke igen efter at have modtaget statuskoder i 4XX-serien.
En undtagelse fra denne regel er 429 rate limit errors; workflows vil automatisk forsøge igen efter at have modtaget et 429-svar og vil respektere Retry-After-headeren, hvis den er til stede. Retry-After registreres i milisekunder. Få mere at vide om specifikke fejlkodeundtagelser i HubSpots udviklerdokumentation.

Få mere at vide om webhooks i udviklernes webhooks-dokumentation. Hvis du har spørgsmål om din specifikke implementering af webhooks med HubSpot, kan du kontakte HubSpot Developers Forums.

Opsæt en POST-anmodning

  • Klik på navnet på en eksisterende arbejdsgang for at redigere den. Eller opret en ny arbejdsgang.
  • I workflow-editoren skal du klikke på + plus-ikonet for at tilføje en handling.
  • Vælg Send en webhook i afsnittet Dataops i venstre panel.

  • Klik på dropdown-menuen Metode, og vælg POST.
  • Indtast webhook-URL'en.
    • Webhook-URL'er er begrænset til en sikker protokol og skal begynde med HTTPS.
    • For at anmode om specifikke oplysninger kan du tilføje forespørgselsparametre som ?queryparameter=abc til webhook-URL'en.
    • Hvis der ikke er tilføjet nogen forespørgselsparametre, sendes en generisk POST- eller GET-anmodning.
  • Konfigurer din godkendelsestype til at godkende anmodninger til din webhook. Du kan enten bruge en anmodningssignatur i din webhook-header eller bruge en API-nøgle:
    • For at bruge en anmodningssignatur i din webhook-header:
      • Klik på rullemenuen Godkendelsestype. Vælg derefter Inkluder anmodningssignatur i header.
      • Indtast derefter dit HubSpot App ID. Lær, hvordan du verificerer anmodningssignaturer.
    • For at bruge en API-nøgle eller en offentlig app, der er oprettet via en udviklerkonto, til godkendelse:
      • Når du bruger en API-nøgle til godkendelse, afhænger det anvendte API-nøglenavn og API-nøgleplacering af, hvordan webhooken er konfigureret. Af sikkerhedsmæssige årsager vises API-nøglen ikke i nogen testanmodninger. Sådan bruger du en API-nøgle:
        • Klik på rullemenuen Authentication type. Vælg derefter API-nøgle.
        • Indtast navnet på din API-nøgle.
        • Klik på dropdown-menuen API-nøgleplacering. Vælg derefter enten Query parameters eller Request header. Læs mere om brug af API-nøgler i HubSpot.
      • Hvis du laver en anmodning til HubSpot API'er:
        • Klik på dropdown-menuen API-nøgle, og vælg en hemmelighed. Den hemmelige værdi skal være i formatet Bearer [YOUR_TOKEN].
        • Indstil værdien af API-nøglenavn til Authorization.
        • Indstil værdien af API-nøglens placering til Request Header.
  • Hvis du vil inkludere alle egenskaber, skal du vælge Include all [object] properties.
  • For kun at inkludere specifikke egenskaber:
    • Vælg Customize request body.
    • Hvis du vil tilpasse anmodningsteksten ved hjælp af en HubSpot-egenskab, skal du indtaste nøglen og vælge en egenskab. Klik på Tilføj egenskab for at tilføje en anden egenskab.
    • Hvis du vil tilpasse anmodningsteksten ved hjælp af et statisk felt, skal du indtaste nøglen og værdien. Klik på Tilføj statisk værdi for at tilføje en anden egenskab.
    • For at fjerne en egenskab eller en statisk værdi skal du klikke på delete papirkurv-ikonet.
  • Klik på Gem.

Bemærk: For at vælge flere outputs skal svaret struktureres som et JSON-objekt.




Opsæt en GET-anmodning

  • For at redigere en eksisterende arbejdsgang skal du klikke på arbejdsgangens navn. Eller opret en ny arbejdsgang.
  • I workflow-editoren skal du klikke på + plus-ikonet for at tilføje en handling.
  • Vælg Send en webhook i afsnittet Dataops i venstre panel.

  • Klik på dropdown-menuen Metode, og vælg GET.
  • Indtast webhook-URL'en.
    • Webhook-URL'er er begrænset til en sikker protokol og skal begynde med HTTPS.
    • For at anmode om specifikke oplysninger kan du tilføje forespørgselsparametre som ?queryparameter=abc til webhook-URL'en.
    • Hvis der ikke er tilføjet nogen forespørgselsparametre, sendes en generisk POST- eller GET-anmodning.
  • Konfigurer din godkendelsestype til at godkende anmodninger til din webhook. Du kan enten bruge en anmodningssignatur i din webhook-header eller bruge en API-nøgle:
    • For at bruge en anmodningssignatur i din webhook-header:
      • Klik på rullemenuen Godkendelsestype. Vælg derefter Inkluder anmodningssignatur i header.
      • Indtast derefter dit HubSpot App ID. Lær, hvordan du verificerer anmodningssignaturer.
    • For at bruge en API-nøgle eller en offentlig app, der er oprettet via en udviklerkonto, til godkendelse:
      • Når du bruger en API-nøgle til godkendelse, afhænger det anvendte API-nøglenavn og API-nøgleplacering af, hvordan webhooken er konfigureret. Af sikkerhedsmæssige årsager vises API-nøglen ikke i nogen testanmodninger. Sådan bruger du en API-nøgle:
        • Klik på rullemenuen Authentication type. Vælg derefter API-nøgle.
        • Indtast navnet på din API-nøgle.
        • Klik på dropdown-menuen API-nøgleplacering. Vælg derefter enten Query parameters eller Request header. Læs mere om brug af API-nøgler i HubSpot.
      • Hvis du laver en anmodning til HubSpot API'er:
        • Klik på dropdown-menuen API-nøgle, og vælg en hemmelighed. Den hemmelige værdi skal være i formatet Bearer [YOUR_TOKEN].
        • Indstil værdien af API-nøglenavn til Authorization.
        • Indstil værdien af API-nøglens placering til Request Header.
Hvis du opretter en GET-anmodning, kan du enten bruge HubSpot-egenskaber eller tilføje statiske værdier som forespørgselsparametre:
  • Sådan bruger du en HubSpot-egenskab som forespørgselsparameter:
    • Indtast nøglen i afsnittet Forespørgselsparametre , og vælg derefter en egenskab.
    • Klik på Tilføj egenskab for at tilføje en anden egenskab.
    • For at fjerne en egenskab skal du klikke på skraldespandsikonetdelete.
  • For at bruge en statisk værdi som forespørgselsparameter:
    • Indtast nøglen i afsnittet Forespørgselsparametre , og indtast derefter en værdi.
    • Klik på Tilføj statisk værdi for at tilføje en anden egenskab.
    • Klik på skraldespandsikonet delete for at fjerne en egenskab.
  • Klik på Gem.



Test din webhook i HubSpot

Når du opsætter din POST- eller GET-webhook, kan du udføre en test for at se webhook-svaret. Under testen, mens data sendes til og hentes fra en tredjepart, vil eksisterende poster i HubSpot ikke blive påvirket. Hvis du bruger en API-nøgle til godkendelse, vil API-nøglen ikke blive vist i nogen testanmodninger.

Når du har testet dit webhook, kan du vælge, hvilke felter der skal sendes ud til brug som input senere i dit workflow. Vælg kun outputs, der er tilgængelige i alle svar. Hvis outputtet bruges i en senere handling, men ikke er tilgængeligt i svaret, vil handlingen mislykkes.

  • Klik på navnet på arbejdsgangen.
  • Klik på Send en webhook-handling i workflow-editoren.
  • Klik på Test action i venstre panel for at udvide afsnittet.
  • Hvis du tester en POST-anmodning, skal du klikke på rullemenuen [objekt] og derefter vælge en post , du vil teste med.
  • Klik på Test.
  • For at tjekke webhook-oplysningerne skal du vælge fanen Response eller Request. På hver fane kan du klikke på Open all for at udvide alle sektioner eller Collapse all for at skjule alle sektioner.
    • På fanen Response skal du klikke på headers : eller body : for at udvide hvert afsnit.
    • På fanen Request skal du klikke på httpHeaders : for at udvide afsnittet.

Test din webhook eksternt

Når du har oprettet dit workflow med en webhook-handling, kan du køre en hurtig test med en dummy-webhook-URL:

  • Når du tester dit webhook eksternt:
    • Hvis der udløses en webhook-handling med en POST-anmodning, sendes der et JSON-svar til webhooken, som indeholder alle oplysninger om kontakten, herunder formularindsendelser, medlemskab af lister og alle kontaktens egenskabsværdier. Det modtagende system kan derefter analysere JSON-dataene og bruge dem i sin egen applikation.
    • Hvis der udløses en webhook-handling med en GET-anmodning, sendes der en generisk GET-anmodning, medmindre der er anvendt yderligere forespørgselsparametre.

Bemærk: Historiske egenskabsværdier vil kun blive returneret i kontaktbaserede workflows. Webhooks, der bruges i alle andre workflowtyper, returnerer kun den seneste værdi.

Bekræft anmodningssignaturer i workflow-webhooks

Når du har valgt Request signature i Authentication-sektionen for din Trigger a web hook-handling, vil HubSpot udfylde webhooken med en X-HubSpot-Signature-header med en SHA-256-hash af sammenkædningen af app-secret for din applikation, HTTP-metoden, URI'en og den ikke-parsede body. Læs mere om dette i udviklernes dokumentation.

For at bekræfte, at de anmodninger, der modtages på din URL, er fra HubSpot:

Udløs workflows fra webhooks

Webhooks kan bruges til at udløse workflows. Når data ændres i en tredjepartsapp, kan det udløse et workflow. Læs mere om at udløse workflows fra webhooks.

Brug webhook-data i datapanelet

Data fra det webhook, der er forbundet med din konto, kan bruges til visse handlinger i datapanelet.

Sådan bruger du data fra den tilsluttede webhook:

  • Klik på navnet på dit workflow.
  • Klik på + plus-ikonet for at tilføje en handling.
  • Vælg en handling , der bruger datapanelet, i panelet til venstre.
  • I datapanelet skal du klikke på rullemenuen View properties or action outputs from og vælge Webhook trigger. Du kan derefter bruge egenskaber fra den tilsluttede webhook.