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.

• 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 sen aika loppuu, 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. Työnkulkuja ei yritetä uudelleen 4XX-sarjan vastauksen tilakoodien saamisen jälkeen.
Poikkeuksena tähän sääntöön ovat 429-nopeusrajoitusvirheet; työnkulut yrittävät automaattisesti uudelleen saatuaan 429-vastauksen ja kunnioittavat Retry-After-otsikkoa, jos se esiintyy. Retry-After-otsake kirjataan millisekunteina. Tutustu erityisiin virhekoodipoikkeuksiin HubSpotin kehittäjädokumentaatiossa.

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

POST-pyynnön määrittäminen

• Siirry HubSpot-tililläsi kohtaan Automaatio > Työnkulut.
• Jos haluat muokata olemassa olevaa työnkulkua, napsauta työnkulun nimeä. Tai luo uusi työnkulku.
• Lisää toiminto työnkulun editorissa napsauttamalla + plus-kuvaketta.
• Valitse vasemmassa paneelissa Data ops -osiossa Send a webhook.
  

• Napsauta Method (Menetelmä ) -pudotusvalikkoa ja valitse POST.
• 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. Voit joko käyttää pyynnön allekirjoitusta webhook-otsakkeessa tai API-avainta:
  • Voit käyttää pyynnön allekirjoitusta webhook-otsakkeessa:
    • Napsauta Authentication type (Todennustyyppi ) -pudotusvalikkoa. Valitse sitten Include request signature in header.
    • Kirjoita sitten HubSpot App ID. Lue, miten tarkistat pyyntöjen allekirjoitukset.

• • API-avaimen tai kehittäjätilin kautta luodun julkisen sovelluksen käyttäminen todennukseen:

• • • Kun API-avainta käytetään todennukseen, 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 HubSpotin API:lle:
      • Napsauta API-avaimen pudotusvalikkoa ja valitse salaisuus. Salaisuusarvon on oltava muodossa Bearer [YOUR_TOKEN].
      • Aseta API-avaimen nimen arvoksi Authorization.
      • Aseta API-avaimen sijainnin arvoksi Request Header.

• Jos haluat sisällyttää kaikki ominaisuudet, valitse Include all [object] properties.
• Jos haluat sisällyttää vain tietyt ominaisuudet:
  
  • Valitse Mukauta pyynnön runko.
  • Jos haluat mukauttaa pyynnön rungon HubSpot-ominaisuuden avulla, kirjoita Avain ja valitse ominaisuus. Jos haluat lisätä toisen ominaisuuden, valitse Lisää ominaisuus.
  • Jos haluat mukauttaa pyynnön rungon staattisen kentän avulla, anna Avain ja Arvo. Voit lisätä toisen ominaisuuden valitsemalla Lisää staattinen arvo.

• • Voit poistaa ominaisuuden tai staattisen arvon napsauttamalla delete roskakorikuvaketta.
• Napsauta Tallenna.

Huomaa: Jos haluat valita useita ulostuloja, vastaus on jäsennettävä JSON-olioksi.

Määritä GET-pyyntö

• Siirry HubSpot-tililläsi kohtaan Automaatio > Työnkulut.
• Jos haluat muokata olemassa olevaa työnkulkua, napsauta työnkulun nimeä. Tai luo uusi työnkulku.
• Lisää toiminto työnkulun editorissa napsauttamalla + plus-kuvaketta.
• Valitse vasemmassa paneelissa Data ops -osiossa Send a webhook.
  

• Napsauta Method (Menetelmä ) -pudotusvalikkoa ja valitse 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. Voit joko käyttää pyynnön allekirjoitusta webhook-otsakkeessa tai API-avainta:
  • Voit käyttää pyynnön allekirjoitusta webhook-otsakkeessa:
    • Napsauta Authentication type (Todennustyyppi ) -pudotusvalikkoa. Valitse sitten Include request signature in header.
    • Kirjoita sitten HubSpot App ID. Lue, miten tarkistat pyyntöjen allekirjoitukset.

• • API-avaimen tai kehittäjätilin kautta luodun julkisen sovelluksen käyttäminen todennukseen:

• • • Kun API-avainta käytetään todennukseen, 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 HubSpotin API:lle:
      • Napsauta API-avaimen pudotusvalikkoa ja valitse salaisuus. Salaisuusarvon on oltava muodossa Bearer [YOUR_TOKEN].
      • Aseta API-avaimen nimen arvoksi Authorization.
      • Aseta API-avaimen sijainnin arvoksi Request Header.

• HubSpot-ominaisuuden käyttäminen kyselyparametrina:
  • Kirjoita Kyselyparametrit-osiossa Avain ja valitse sitten ominaisuus.
  • Jos haluat lisätä toisen ominaisuuden, valitse Lisää ominaisuus.
  • Jos haluat poistaa ominaisuuden, napsauta delete Poista-kuvaketta.
• Staattisen arvon käyttäminen kyselyparametrina:
  • Kirjoita kyselyparametrit-osiossa Avain ja anna sitten arvo.
  • Voit lisätä toisen ominaisuuden valitsemalla Lisää staattinen arvo.
  • Voit poistaa ominaisuuden napsauttamalla delete poistokuvaketta.
• Napsauta Tallenna.

Testaa webhookisi HubSpotissa

Kun olet määrittänyt POST- tai GET-verkkokoukkua, voit suorittaa testin nähdäksesi verkkokoukun vastauksen. 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ä.

Webhookin testaamisen jälkeen voit valita, 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.

• Siirry HubSpot-tililläsi kohtaan Automaatio > Työnkulut.
• Napsauta työnkulun nimeä.
• Napsauta työnkulkueditorissa Lähetä webhook-toiminto.
• Laajenna osio vasemmassa paneelissa valitsemalla Test action.
• Jos testaat POST-pyyntöä, webhook-testin määrittäminen eroaa sen mukaan, oletko valinnut Mukauta pyynnön runko vai Sisällytä kaikki [objektin] ominaisuudet webhook-toimintoon.
  
  • Jos olet valinnut Customize request body (Mukauta pyyntörunko) -vaihtoehdon, syötä testin ominaisuustestiarvot.
  • Jos olet valinnut Include all [object] properties (Sisällytä kaikki [objektin] ominaisuudet) -vaihtoehdon, napsauta [object] -pudotusvalikkoa ja valitse sitten 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 selaimessasi 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.
  
  

• Kun testaat webhookia ulkoisesti:
  • Jos webhook-toiminto, jossa on POST-pyyntö, käynnistetään, 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 verkkokoukuissa

Jos olet valinnut Request signature (Pyynnön allekirjoitus ) -vaihtoehdon Trigger a webhook -toiminnon Authentication (Todentaminen ) -osiossa, HubSpot täyttää webhookin X-HubSpot-Signature-otsakkeella, jossa on SHA-256-hash, joka koostuu 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.

Käynnistä työnkulkuja webhookeista.

Webhookeja voidaan käyttää työnkulkujen käynnistämiseen. Kun tiedot muuttuvat kolmannen osapuolen sovelluksessa, tämä voi käynnistää työnkulun. Lisätietoja työnkulkujen käynnistämisestä webhooksista.

Webhook-tietojen käyttäminen tietopaneelissa

Tiliin liitetyn webhookin tietoja voidaan käyttää tiettyihin toimintoihin datapaneelissa.

Liitetyn webhookin tietojen käyttäminen:

• Siirry HubSpot-tililläsi kohtaan Automaatio > Työnkulut.
• Napsauta työnkulun nimeä.
• Lisää toiminto napsauttamalla + plus-kuvaketta.
• Valitse vasemmasta paneelista toiminto , joka käyttää tietopaneelia.
• Napsauta datapaneelissa Näytä ominaisuudet tai Toiminnon tuotokset -pudotusvalikosta ja valitse Webhook-liipaisin. Voit sitten käyttää yhdistetyn webhookin ominaisuuksia.