Bruk webhooks med HubSpot-arbeidsflyter
Sist oppdatert: juni 11, 2024
Gjelder for:
Operations Hub Professional , Enterprise |
Bruk webhooks i arbeidsflyter for å sende eller hente informasjon mellom HubSpot og andre eksterne verktøy. Det finnes en rekke bruksområder for webhooks, og eksempler på populære bruksområder for webhooks inkluderer:
-
Sende HubSpot-kontaktdata til et annet system, for eksempel et CRM-system, når kontakten fyller ut et bestemt skjema på nettstedet ditt.
-
Sende avtaledata til et eksternt forsendelseshåndteringssystem for å opprette en innkjøpsordre.
- Hente data fra et annet system for å oppdatere HubSpot-postene dine.
Du kan sende både POST- og GET-forespørsler ved hjelp av arbeidsflyter. HubSpot regulerer webhook-trafikk separat fra andre arbeidsflytprosesser. Dette gjøres for å effektivisere arbeidsflyten og webhook-ytelsen. Når en webhook er treg eller tidsavbrudd, kan det ta lengre tid enn forventet å utføre arbeidsflythandlingen.
Merk: HubSpot vil prøve mislykkede webhooks på nytt i opptil tre dager, med start ett minutt etter at feilen oppstod. Etterfølgende feil vil bli forsøkt på nytt med økende intervaller, med maksimalt åtte timer mellom hvert forsøk. Arbeidsflyter prøver ikke på nytt etter å ha mottatt svarstatuskoder i 4XX-serien.
Et unntak fra denne regelen er 429 rate limit-feil; arbeidsflyter vil automatisk prøve på nytt etter å ha mottatt et 429-svar, og vil respektere Retry-After-overskriften hvis den er til stede. Retry-After registreres i milisekunder. Finn ut mer om spesifikke feilkodeunntak i HubSpots utviklerdokumentasjon.
Finn ut mer om webhooks i utviklerdokumentasjonen for webhooks. Hvis du har spørsmål om din spesifikke implementering av webhooks med HubSpot, kan du ta kontakt på HubSpot Developers Forums.
Sett opp en POST-forespørsel
- Gå til Automatiseringer > Arbeidsflyter i HubSpot-kontoen din.
- Klikk på navnet på arbeidsflyten for å redigere en eksisterende arbeidsflyt. Du kan også opprette en ny arbeidsflyt.
- I arbeidsflytredigeringsprogrammet klikker du på plussikonet for å legge til en handling.
- Velg Send en webhook i delen Dataops i panelet til venstre.
- Klikk på rullegardinmenyen Metode, og velg POST.
- Skriv inn URL-adressen til webhooken.
- Webhook-URL-er er begrenset til en sikker protokoll og må begynne med HTTPS.
- Hvis du vil be om spesifikk informasjon, kan du legge til spørringsparametere som
?queryparameter=abc
i webhook-URL-en. - Hvis ingen spørringsparametere er lagt til, sendes en generisk POST- eller GET-forespørsel.
- Konfigurer autentiseringstypen for å autentisere forespørsler til webhooken. Du kan enten bruke en forespørselssignatur i webhook-overskriften eller bruke en API-nøkkel:
- Slik bruker du en forespørselssignatur i webhook-overskriften:
- Klikk på rullegardinmenyen Autentiseringstype. Velg deretter Inkluder forespørselssignatur i overskriften.
- Skriv deretter inn HubSpot-app-ID-en din. Finn ut hvordan du verifiserer forespørselssignaturer.
- Slik bruker du en forespørselssignatur i webhook-overskriften:
-
- Slik bruker du en API-nøkkel eller en offentlig app som er opprettet via en utviklerkonto for autentisering:
-
-
- Når du bruker en API-nøkkel for autentisering, er API-nøkkelnavnet og API-nøkkelplasseringen som brukes, avhengig av hvordan webhooken er konfigurert. Av sikkerhetsgrunner vises ikke API-nøkkelen i testforespørsler. Slik bruker du en API-nøkkel:
- Klikk på rullegardinmenyen Autentiseringstype. Velg deretter API-nøkkel.
- Når du bruker en API-nøkkel for autentisering, er API-nøkkelnavnet og API-nøkkelplasseringen som brukes, avhengig av hvordan webhooken er konfigurert. Av sikkerhetsgrunner vises ikke API-nøkkelen i testforespørsler. Slik bruker du en API-nøkkel:
-
-
-
-
- Skriv inn navnet på API-nøkkelen.
- Klikk på nedtrekksmenyen API-nøkkelplassering. Velg deretter enten Query parameters eller Request header. Lær mer om bruk av API-nøkler i HubSpot.
- Hvis du gjør en forespørsel til HubSpots API-er:
- Klikk på rullegardinmenyen API-nøkkel og velg en hemmelighet. Den hemmelige verdien må være i formatet Bearer [YOUR_TOKEN].
- Angi verdien for API-nøkkelnavn til Authorization.
- Angi verdien for API-nøkkelens plassering til Request Header.
-
-
- Hvis du vil inkludere alle egenskaper, velger du Inkluder alle [objekt]-egenskaper.
- For å inkludere bare bestemte egenskaper:
- Velg Tilpass forespørselsteksten.
- Hvis du vil tilpasse forespørselsteksten ved hjelp av en HubSpot-egenskap, skriver du inn nøkkelen og velger en egenskap. Klikk på Legg til egenskap for å legge til en annen egenskap.
- Hvis du vil tilpasse forespørselsdelen ved hjelp av et statisk felt, skriver du inn nøkkel og verdi. Klikk på Legg til statisk verdi for å legge til en annen egenskap.
-
- Hvis du vil fjerne en egenskap eller statisk verdi, klikker du på delete papirkurvikonet.
- Klikk på Lagre.
Merk: Hvis du vil velge flere utganger, må svaret være strukturert som et JSON-objekt.
Sett opp en GET-forespørsel
- Gå til Automatiseringer > Arbeidsflyter i HubSpot-kontoen din.
- Klikk på navnet på arbeidsflyten for å redigere en eksisterende arbeidsflyt. Du kan også opprette en ny arbeidsflyt.
- I arbeidsflytredigeringsprogrammet klikker du på plussikonet for å legge til en handling.
- Velg Send en webhook i delen Dataops i panelet til venstre.
- Klikk på rullegardinmenyen Metode, og velg GET.
- Skriv inn URL-adressen til webhooken.
- Webhook-URL-er er begrenset til en sikker protokoll og må begynne med HTTPS.
- Hvis du vil be om spesifikk informasjon, kan du legge til spørringsparametere som
?queryparameter=abc
i webhook-URL-en. - Hvis ingen spørringsparametere er lagt til, vil en generisk POST- eller GET-forespørsel bli sendt.
- Konfigurer autentiseringstypen for å autentisere forespørsler til webhooken. Du kan enten bruke en forespørselssignatur i webhook-overskriften eller bruke en API-nøkkel:
- Slik bruker du en forespørselssignatur i webhook-overskriften:
- Klikk på rullegardinmenyen Autentiseringstype. Velg deretter Inkluder forespørselssignatur i overskriften.
- Skriv deretter inn HubSpot-app-ID-en din. Finn ut hvordan du verifiserer forespørselssignaturer.
- Slik bruker du en forespørselssignatur i webhook-overskriften:
-
- Slik bruker du en API-nøkkel eller en offentlig app som er opprettet via en utviklerkonto for autentisering:
-
-
- Når du bruker en API-nøkkel for autentisering, er API-nøkkelnavnet og API-nøkkelplasseringen som brukes, avhengig av hvordan webhooken er konfigurert. Av sikkerhetsgrunner vil ikke API-nøkkelen vises i testforespørsler. Slik bruker du en API-nøkkel:
- Klikk på rullegardinmenyen Autentiseringstype. Velg deretter API-nøkkel.
- Når du bruker en API-nøkkel for autentisering, er API-nøkkelnavnet og API-nøkkelplasseringen som brukes, avhengig av hvordan webhooken er konfigurert. Av sikkerhetsgrunner vil ikke API-nøkkelen vises i testforespørsler. Slik bruker du en API-nøkkel:
-
-
-
-
- Skriv inn navnet på API-nøkkelen.
- Klikk på nedtrekksmenyen API-nøkkelplassering. Velg deretter enten Query parameters eller Request header. Lær mer om bruk av API-nøkler i HubSpot.
- Hvis du gjør en forespørsel til HubSpots API-er:
- Klikk på rullegardinmenyen API-nøkkel og velg en hemmelighet. Den hemmelige verdien må være i formatet Bearer [YOUR_TOKEN].
- Angi verdien for API-nøkkelnavn til Authorization.
- Angi verdien for API-nøkkelens plassering til Request Header.
-
-
- Slik bruker du en HubSpot-egenskap som en spørringsparameter:
- Under delen Spørringsparametere skriver du inn Nøkkelen og velger deretter en egenskap.
- Klikk på Legg til egenskap for å legge til en annen egenskap.
- For å fjerne en egenskap klikker du på delete søppelbøtteikonet.
- Slik bruker du en statisk verdi som spørringsparameter:
- Skriv inn Nøkkelen under Spørringsparametere , og skriv deretter inn en verdi.
- Klikk på Legg til statisk verdi for å legge til en annen egenskap.
- Hvis du vil fjerne en egenskap, klikker du på delete søppelbøtteikonet.
- Klikk på Lagre.
Test webhooken din i HubSpot
Når du konfigurerer POST- eller GET-webhooken din, kan du utføre en test for å se webhook-svaret. Under testen, mens data sendes til og hentes fra en tredjepart, vil eksisterende poster i HubSpot ikke bli påvirket. Hvis du bruker en API-nøkkel for autentisering, vil ikke API-nøkkelen vises i testforespørsler.
Når du har testet webhooken, kan du velge hvilke felt som skal sendes ut for bruk som inndata senere i arbeidsflyten. Velg bare utdata som er tilgjengelige i alle svar. Hvis utdataene brukes i en senere handling, men ikke er tilgjengelige i svaret, vil handlingen mislykkes.
- Gå til Automatiseringer > Arbeidsflyter i HubSpot-kontoen din.
- Klikk på navnet på arbeidsflyten.
- I arbeidsflytredigeringsprogrammet klikker du på Send en webhook-handling.
- I panelet til venstre klikker du på Test handling for å utvide delen.
- Hvis du tester en POST-forespørsel, klikker du på rullegardinmenyen [objekt] og velger deretter en post du vil teste med.
- Klikk på Test.
- Hvis du vil sjekke webhook-detaljene, velger du fanen Svar eller Forespørsel. På hver fane kan du klikke på Åpne alle for å utvide alle seksjoner, eller Skjul alle for å skjule alle seksjoner.
- I Response-fanen klikker du på Headers : eller Body : for å utvide hver del.
- I fanen Request (Forespørsel ) klikker du på httpHeaders : for å utvide delen.
Test webhooken din eksternt
Når du har opprettet arbeidsflyten med en webhook-handling, kan du kjøre en rask test med en dummy-webhook-URL:
- Gå til https://webhook.site i nettleseren, og kopier den unike URL-adressen.
- Lim inn URL-adressen i feltet Webhook URL i webhook-handlingen din.
- Når arbeidsflyten er slått på, kan du registrere en testkontakt manuelt.
- Når du tester webhooken eksternt:
- Hvis en webhook-handling med en POST-forespørsel utløses, sendes en JSON-svartekst til webhooken som inneholder all informasjon om kontakten, inkludert skjemainnleveringer, listemedlemskap og alle kontaktens egenskapsverdier. Mottakersystemet kan deretter analysere JSON-dataene og bruke dem i sin egen applikasjon.
- Hvis en webhook-handling med en GET-forespørsel utløses, sendes en generisk GET-forespørsel, med mindre det er brukt ekstra spørringsparametere.
Merk: Historiske egenskapsverdier vil kun returneres i kontaktbaserte arbeidsflyter. Webhooks som brukes i alle andre typer arbeidsflyter, returnerer bare den nyeste verdien.
Verifiser forespørselssignaturer i webhooks for arbeidsflyter
Når du har valgt Forespørselssignatur i delen Autentisering for handlingen Utløs en webhook, vil HubSpot fylle ut webhooken med et X-HubSpot-Signature-overskrift med en SHA-256-hash av sammenkjedningen av app-hemmeligheten for applikasjonen din, HTTP-metoden, URI-en og den uparsede brødteksten. Finn ut mer om dette i dokumentasjonen for utviklere.
Slik bekrefter du at forespørslene som mottas på URL-adressen din, kommer fra HubSpot:
- Eie en utviklerkonto. Hvis du ikke har en, kan du registrere deg for en utviklerkonto.
- Eie en app. Hvis du ikke har en app, kan du lære hvordan du oppretter en app.
- Sjekk hashverdien til signaturen.
Utløs arbeidsflyter fra webhooks
Webhooks kan brukes til å utløse arbeidsflyter. Når data endres i en tredjepartsapp, kan dette utløse en arbeidsflyt. Finn ut mer om hvordan du utløser arbeidsflyter fra webhooks.
Bruk webhook-data i datapanelet
Data fra webhooken som er koblet til kontoen din, kan brukes til visse handlinger i datapanelet.
Slik bruker du data fra den tilkoblede webhooken:
- Gå til Automatiseringer > Arbeidsflyter i HubSpot-kontoen din.
- Klikk på navnet på arbeidsflyten din.
- Klikk på plussikonet for å legge til en handling.
- Velg en handling som bruker datapanelet i panelet til venstre.
- I datapanelet klikker du på rullegardinmenyen Vis egenskaper eller handlingsutganger fra og velger Webhook-utløser. Du kan deretter bruke egenskaper fra den tilkoblede webhooken.