Käytä verkkokoukkuja HubSpot-työnkulkujen kanssa

Käytä webhookeja työnkuluissa tietojen lähettämiseen tai hakemiseen HubSpotin ja muiden ulkoisten työkalujen välillä. Webhookeille on monenlaisia käyttötarkoituksia, esimerkkejä webhookien suosituista käyttötapauksista ovat mm. seuraavat:

• HubSpotin yhteystietojen lähettäminen toiseen järjestelmään, kuten CRM-järjestelmään, kun kyseinen yhteyshenkilö täyttää tietyn lomakkeen sivustollasi.

• Kaupan tietojen lähettäminen ulkoiseen lähetysten käsittelyjärjestelmään ostotilauksen luomista varten.

• Chat-ilmoitusten lähettäminen ulkoisesta järjestelmästä yrityksesi chat-virtaan, jotta työntekijöille voidaan ilmoittaa, että jotain tärkeää on tapahtunut.

• Tietojen hakeminen toisesta järjestelmästä HubSpot-tietueiden päivittämiseksi.

Voit lähettää sekä POST- että GET-pyyntöjä työnkulkujen avulla. HubSpot säätelee webhook-liikennettä erillään muista työnkulun prosesseista. Tämä tehdään työnkulkujen ja webhookien suorituskyvyn tehostamiseksi. Kun webhook on hidas tai aikakatkaisu, työnkulun toimenpiteen suorittaminen voi kestää odotettua kauemmin.

Huomaa: HubSpot yrittää epäonnistuneita webhookeja uudelleen enintään kolmen päivän ajan, alkaen minuutin kuluttua epäonnistumisesta. Seuraavia epäonnistumisia yritetään uudelleen yhä useammin, ja kokeiden välinen aika voi olla enintään kahdeksan tuntia. Tutustu erityisiin virhekoodipoikkeuksiin HubSpotin kehittäjädokumentaatiossa.

Lue lisää webhooksista kehittäjien webhooks-asiakirjoista. Jos sinulla on kysyttävää webhookien erityisestä toteutuksesta HubSpotin kanssa, ota yhteyttä HubSpotin kehittäjäfoorumeilla.

Webhookin määrittäminen työnkulkuun

• Siirry HubSpot-tililläsi kohtaan Automaatio > Työnkulut.
• Napsauta työnkulunnimeä.
• Lisää toiminto napsauttamalla +-kuvaketta.
• Valitse oikeassa paneelissa Lähetä webhook.
• Napsauta Method (Menetelmä ) -pudotusvalikkoa ja valitse POST tai GET.
• Kirjoita webhookin URL-osoite. Webhook-URL-osoitteet on rajoitettu suojattuun protokollaan, ja niiden on alettava HTTPS:llä. Voit pyytää tiettyjä tietoja lisäämällä Webhook-URL-osoitteeseen kyselyparametreja, kuten ?queryparameter=abc. Jos kyselyparametreja ei ole lisätty, lähetetään yleinen POST- tai GET-pyyntö.
• Määritä todennustyyppi webhookiin kohdistuvien pyyntöjen todennusta varten:
  • Pyynnön allekirjoituksen käyttäminen webhook-otsakkeessa:
    • Napsauta Authentication type (Todennustyyppi ) -pudotusvalikkoa. Valitse sitten Include request signature in header.
    • Kirjoita sitten HubSpot App ID. Lue, mitentarkistat pyyntöjen allekirjoitukset.

• • Voit käyttää todennukseen myös API-avainta tai HubSpotin yksityistä sovellusta.

Huomaa: 30. marraskuuta 2022 alkaen HubSpotin API-avaimet ovat poistuneet käytöstä, eikä niitä enää tueta. Voit edelleen käyttää ulkoisia API-avaimia todennukseen HubSpot-työnkuluissa.

• • • Kun käytät API-avainta todennukseen, käytetyn API-avaimen nimi ja API-avaimen sijainti riippuvat siitä, miten webhook on määritetty. Turvallisuussyistä API-avain ei näy testipyynnöissä. API-avaimen käyttäminen:
      • Napsauta todennustyypin pudotusvalikkoa. Valitse sitten API-avain.

• • • • Kirjoita API-avaimen nimi.
      • Napsauta API-avaimen sijainti -pudotusvalikkoa. Valitse sitten joko kyselyparametrit tai pyynnön otsikko. Lisätietoja API-avainten käytöstä HubSpotissa.
    • Jos teet pyynnön johonkin HubSpotin API:sta:
      • Napsauta API-avaimen pudotusvalikkoa ja valitse salaisuus. Salaisen arvoon oltava muodossa Bearer [YOUR_TOKEN]..
      • Aseta API-avaimen nimen arvoksi Authorization.
      • Aseta API-avaimen sijainnin arvoksi Request Header.
• Jos määrität POST-pyynnön, voit valita, haluatko sisällyttää kaikki CRM-tietueen ominaisuudet vai lähettää vain tietyt ominaisuudet:
  • Jos haluat sisällyttää kaikki ominaisuudet, valitse Mukauta pyynnön runko -osiossa Sisällytä kaikki ominaisuudet.
  • Jos haluat sisällyttää vain tiettyjä ominaisuuksia:
    
    • Valitse Mukauta pyynnön runko -osiossa Valitse tietyt ominaisuudet.
    • Napsauta Choose property (Valitse ominaisuus ) -pudotusvalikkoa. Napsauta sitten [objekti] tässä työnkulussa ja valitse ominaisuus.
    • Jos haluat muuttaa ominaisuuden nimeä webhookissa, muokkaa Ominaisuuden nimi -tekstikenttää. Tämä päivittää vain ominaisuuden nimen POST-pyynnössä, se ei päivitä ominaisuuden nimeä tai sisäistä nimeä HubSpotissa.
    • Jos haluat lisätä toisen ominaisuuden, valitse Lisää ominaisuus.
    • Jos haluat poistaa ominaisuuden, napsauta roskakorin poistokuvaketta.
      .

• Jos määrität GET-pyynnön, voit käyttää ominaisuuksia kyselyparametreina:
  
  • Napsauta kyselyparametrit-osiossa Valitse ominaisuus -pudotusvalikkoa. Napsauta sitten [objekti] tässä työnkulussa ja valitse ominaisuus.
  • Jos haluat muuttaa ominaisuuden nimeä kyselyparametrissa, muokkaa Ominaisuuden nimi -tekstikenttää. Tämä päivittää vain ominaisuuden nimen GET-pyynnössä, se ei päivitä ominaisuuden nimeä tai sisäistä nimeä HubSpotissa.

• • Jos haluat lisätä toisen ominaisuuden, valitse Lisää kyselyparametri.
  • Jos haluat poistaa ominaisuuden, napsauta poista roskakori-kuvaketta.
• Napsauta Tallenna.
  
  

POST-pyynnön mukauttaminen

Jos määrität POST-pyynnön, voit valita, haluatko sisällyttää kaikki CRM-tietueen ominaisuudet vai lähettää vain tietyt ominaisuudet:

• Jos haluat sisällyttää kaikki ominaisuudet, valitse Mukauta pyynnön runko -osiossa Sisällytä kaikki ominaisuudet.
• Jos haluat sisällyttää vain tiettyjä ominaisuuksia:
  
  • Valitse Request body (Pyynnön runko ) -osiossa Customize request body (Mukauta pyynnön runko).
  • Kirjoita avain ja arvo.
  • Jos haluat muuttaa ominaisuuden nimeä webhookissa, muokkaa Key-tekstikenttää . Tämä päivittää vain ominaisuuden nimen POST-pyynnössä, se ei päivitä ominaisuuden nimeä tai sisäistä nimeä HubSpotissa.
  • Jos haluat lisätä toisen ominaisuuden, napsauta Add property (Lisää ominaisuus) -painiketta.
  • Jos haluat poistaa ominaisuuden, napsauta roskakorin poistokuvaketta.
    .

GET-pyyntöjen mukauttaminen

Jos määrität GET-pyynnön, voit käyttää ominaisuuksia kyselyparametreina tiettyjen tietojen hakemiseen:

• Kirjoita Kyselyparametrit-osiossa Avain ja valitse sitten ominaisuus.
• Jos haluat muuttaa ominaisuuden nimeä kyselyparametrissa, muokkaa Ominaisuuden nimi -tekstikenttää. Tämä päivittää vain ominaisuuden nimen GET-pyynnössä, se ei päivitä ominaisuuden nimeä tai sisäistä nimeä HubSpotissa.

• Jos haluat lisätä toisen ominaisuuden, valitse Lisää ominaisuus.
• Voit poistaa ominaisuuden napsauttamalla poisto roskakorin kuvaketta.
• Valitse todennustyyppi pudotusvalikosta.
• Napsauta Tallenna.
  
  

Testaa verkkokoukku HubSpotissa

Kun olet määrittänyt POST- tai GET-verkkokoukun, voit suorittaa testin, jolla voit tarkastella verkkokoukun vastausta. Testin aikana tietoja lähetetään ja haetaan kolmannelle osapuolelle, mutta se ei vaikuta HubSpotissa oleviin tietueisiin . Jos käytät API-avainta todennukseen, API-avain ei näy testipyynnöissä.

Kun olet testannut webhookin, voitvalita, mitkä kentät tulostetaan käytettäväksi syötteinä myöhemmin työnkulussa. Valitse vain tulosteet, jotka ovat käytettävissä jokaisessa vastauksessa. Jos tulostetta käytetään myöhemmässä toiminnossa, mutta se ei ole käytettävissä vastauksessa, toiminto epäonnistuu.

• Laajenna osio sivupaneelissa napsauttamalla Testaa toiminto.
• Napsauta avattavaa Object (Kohde ) -valikkoa ja valitse sitten Record (Tietue ), jolla testataan.
• Napsauta Testaa.
• Voit tarkistaa webhookin tiedot valitsemalla Vastaus- tai Pyyntö-välilehden. Kummallakin välilehdellä voit avata kaikki osiot valitsemalla Avaa kaikki tai sulkea kaikki o siot valitsemalla Sulje kaikki.
  
  • Vastaus-välilehdessä voit laajentaa kunkin osion napsauttamalla otsikot: tai runko: .
  • Laajenna Request (Pyyntö ) -välilehdessä osio napsauttamalla httpHeaders: .
    
    

Testaa verkkokoukku ulkoisesti

Kun olet luonut työnkulun webhook-toiminnolla, voit suorittaa nopean testin valesivun webhook-URL-osoitteella:

• Siirry selaimessa osoitteeseen https://webhook.site ja kopioi yksilöllinen URL-osoite.
• Liitä URL-osoite webhook-toiminnon Webhook URL - kenttään.
  
  

• Kun työnkulku on otettu käyttöön, voit rekisteröidä testikontaktin manuaalisesti.

Jos POST-pyynnön sisältävä webhook-toiminto käynnistyy, webhookiin lähetetään JSON-vastausrunko, joka sisältää kaikki tiedot yhteystiedosta, mukaan lukien lomakkeiden lähettämiset, luettelon jäsenyydet ja kaikki yhteystiedon ominaisuuksien arvot. Vastaanottava järjestelmä voi sitten jäsentää JSON-tiedot ja käyttää niitä omassa sovelluksessaan.

Jos GET-pyynnön sisältävä webhook-toiminto käynnistetään, lähetetään yleinen GET-pyyntö, ellei ole käytetty lisäkyselyparametreja.

Huomaa: historialliset ominaisuuksien arvot palautetaan vain yhteystietopohjaisissa työnkuluissa. Kaikissa muissa työnkulkutyypeissä käytetyt webhookit palauttavat vain viimeisimmän arvon.

Pyyntöjen allekirjoitusten tarkistaminen työnkulun webhookeissa

Jos olet valinnut Request signature (Pyynnön allekirjoitus ) -toiminnon Authentication (Todentaminen ) -osiossa Trigger a webhook -toiminnon, HubSpot täyttää webhookin X-HubSpot-Signature-otsakkeella, jossa on SHA-256-haastemerkki sovelluksesi app-salaisuuden, HTTP-menetelmän, URI:n ja käsittelemättömän rungon yhdistelmästä. Lue lisää tästä kehittäjien dokumentaatiosta.

Voit varmistaa, että URL-osoitteeseesi saapuvat pyynnöt ovat HubSpotilta:

• Omista kehittäjätili. Jos sinulla ei ole sellaista, rekisteröi kehittäjätili.
• Omistat sovelluksen. Jos sinulla ei ole sovellusta, opettele luomaan sovellus.
• Tarkista allekirjoituksen hash-arvo.