Pereiti prie turinio
Rex, jūsų DI asistentas: rutiną atliks jis, idėjos – jūsų 👉 Susipažinkite su Rex

Siųskite duomenis į savo sistemas naudodami webhook'us

Gaukite užklausą į savo URL, kai kas nors užsiregistruoja, dalyvauja ar laimi: su pasirašytais duomenimis, pagrindiniu autentifikavimu, pasirinktiniais duomenimis ir kiekvieno pristatymo žurnalu.

Webhook'as siunčia duomenis jūsų pasirinktu URL tą akimirką, kai kas nors įvyksta, pavyzdžiui, kai kas nors dalyvauja kampanijoje arba laimi prizą. Juos priimančią sistemą sukonfigūruoja jūsų programuotojas.

Webhook'ai įtraukti į planus, kuriuose yra Webhooks & API (nuo Basic ir aukštesni).

Kampanijos ar paskyros webhook'ai?

  • Kampanijos webhook'ai nustatomi kampanijos redaktoriuje ir suveikia tik tai kampanijai. Jie turi įvykius „Every time a lead participates in a campaign“ ir „When a lead wins a prize“ bei daugiausia parinkčių.
  • Paskyros webhook'ai nustatomi skiltyje Settings > Webhooks. Jie turi įvykį „When a new lead is created“: jis suveikia vieną kartą kiekvienam asmeniui, kai jis pirmą kartą įtraukiamas į jūsų potencialius klientus, nepriklausomai nuo to, iš kurios kampanijos jis atėjo.

Webhook'o pridėjimas prie kampanijos

  1. Atidarykite kampaniją redaktoriuje ir eikite į Connect > Webhooks.
  2. Spustelėkite Add webhook.
  3. Įveskite Payload URL. Jis turi prasidėti https: „We only support webhooks over HTTPS to ensure that the data sent remains secure.“
  4. Pasirinkite Content type: application/json arba application/x-www-form-urlencoded.
  5. Pasirinkite Method. Formoje iš pradžių nustatytas GET, kuris siunčia duomenis URL adrese. Pasirinkite POST, kad duomenys būtų siunčiami užklausos turinyje – to tikisi dauguma sistemų.
  6. Skiltyje Authentication (tik POST atveju) pasirinkite Basic Auth, jei jūsų URL reikalauja vartotojo vardo ir slaptažodžio, ir užpildykite Username bei Password. Kitu atveju palikite None.
  7. Įveskite Secret, kad užklausos būtų pasirašytos (rekomenduojama). Žr. skyrių „Parašo tikrinimas“ toliau.
  8. Įjunkite Log response body, jei norite matyti, ką atsako jūsų sistema. „Enable to store the response body for debugging.“
  9. Palikite įjungtą Active. „We will only deliver events if the webhook is active.“
  10. Pasirinkite įvykį: „Every time a lead participates in a campaign“ arba „When a lead wins a prize“.
  11. Įjunkite Custom payload, jei laukus norite pasirinkti patys (žr. toliau).
  12. Spustelėkite Add webhook. Pamatysite „Webhook added“.

Skydelyje Webhooks pateikiami kampanijos webhook'ai su būsena Active arba Inactive, o jei paskutinė užklausa nepavyko – Last delivery failed. Per Actions galite webhook'ą redaguoti (Edit), peržiūrėti pristatymus (See deliveries) arba ištrinti (Delete). Redaguodami webhook'ą palikite Secret tuščią, jei norite išsaugoti esamą.

Paskyros webhook'o pridėjimas

  1. Eikite į Settings > Webhooks (skiltyje Developers). Jūsų webhook'ai pateikiami po My webhooks (arba po kiekvieno potencialių klientų sąrašo pavadinimu, jei jų turite kelis).
  2. Spustelėkite kortelę su pliuso ženklu, kad pridėtumėte webhook'ą. Dialogo lange Add webhook rašoma „Send a request to an external URL whenever selected events happen.“
  3. Užpildykite Payload URL, Content type („Select content type of the webhook“), Method ir Secret, kaip aprašyta aukščiau.
  4. Skiltyje Which events should trigger the webhook? pasirinkite „When a new lead is created“.
  5. Pažymėkite „Yes, allow me to specify a customized payload (Advanced users only)“, jei norite naudoti savo laukus.
  6. Jei reikia, pažymėkite Log response body („This webhook will log the response body“) ir palikite pažymėtą Active („We will deliver event details when this hook is triggered“).
  7. Spustelėkite Add webhook.

Spustelėkite webhook'ą, kad jį pakeistumėte (Save changes), nustatytumėte naują slaptą raktą (New secret), atidarytumėte Show deliveries arba ištrintumėte (Delete webhook) („This action cannot be reverted!“).

Kas siunčiama

Pagal numatytuosius nustatymus užklausos turinyje yra event (įvykio pavadinimas: lead_created_on_campaign, new_campaign_winner arba lead_created) ir objektas data:

  • campaign: kampanijos id ir name (kampanijos webhook'ai)
  • lead: potencialaus kliento formos laukai pagal jų raktus (pavyzdžiui, first_name), taip pat id, phone_number ir created_at
  • lead.permissions: kiekvienam sutikimo žymimajam langeliui – ar jis buvo pažymėtas, tekstas, data ir IP adresas (kampanijos webhook'ai)
  • participant: kanalas (channel), iš kurio atėjo asmuo, ir kada jis dalyvavo (kampanijos webhook'ai)
  • quiz: atsakymai į pavadintus viktorinos klausimus, taip pat pateikiami skaitomais pavadinimais, prasidedančiais „Simple“
  • prize: prizo id, name, value, coupon_code ir kada jis buvo laimėtas (laimėtojų webhook'ai)

Tuščios reikšmės nesiunčiamos, kaip ir nepatvirtinti sutikimai. Naudojant GET metodą, tie patys duomenys siunčiami kaip užklausos parametrai URL adrese.

Pasirinktiniai duomenys

Įjungus Custom payload, siunčiami tik jūsų pasirinkti laukai, be event apvalkalo.

  1. Skiltyje Data mapping spustelėkite Add mapping.
  2. Įveskite lauko pavadinimą (Field name), kurio tikisi jūsų sistema. Naudokite raides, skaičius, brūkšnelius ir apatinius brūkšnius.
  3. Pasirinkite siunčiamą Scratcher lauką („Group → Field“) arba Custom value ir įveskite fiksuotą reikšmę (Value).
  4. Pakartokite kiekvienam laukui. Lauką pašalinsite paspaudę šiukšliadėžės piktogramą (Remove arba Remove data mapping).

Parašo tikrinimas

Jei nustatėte slaptą raktą, kiekvienoje užklausoje yra antraštė X-Hub-Signature: sha1=, po kurio eina JSON formatu užkoduotų duomenų (užklausos turinio, kaip aprašyta aukščiau) HMAC-SHA1 maiša, apskaičiuota naudojant jūsų slaptą raktą. Apskaičiuokite tą pačią reikšmę savo pusėje ir palyginkite – taip įsitikinsite, kad užklausa atėjo iš Scratcher.

Pristatymai ir pakartotiniai bandymai

  • Jei jūsų URL neatsako arba grąžina klaidą (būsenos kodas 400 ar didesnis), Scratcher bando dar du kartus: po 5 sekundžių ir po minutės.
  • Peradresavimai nevykdomi, todėl naudokite galutinį URL.
  • Atidarykite pristatymus (kampanijoje – See deliveries, paskyros webhook'ams – Show deliveries), kad pamatytumėte kiekvieną užklausą ir atsakymą. Prie kiekvieno pristatymo rodomas jo ID, užklausa (Request) ir atsakymas (Response) su būsenos kodu (bei Response body, jei jį registruojate). Naudokite copy, kad nukopijuotumėte duomenis.
  • Įjunkite Show only failed deliveries, kad matytumėte tik problemas. Viršuje rodoma „Failed deliveries in the last 60 days“.
  • Spustelėkite Retry, kad pristatymą išsiųstumėte iš naujo: „The webhook is being resent.“
  • „Webhook delivery logs are retained for 60 days.“

Trikčių šalinimas

  • „The ... field must use HTTPS.“: Payload URL prasideda http. Naudokite https.
  • Visi pristatymai nepavyksta ir nėra atsakymo: URL nepasiekiamas iš interneto, pavyzdžiui, tai vietinis ar vidinis adresas. Naudokite viešą URL.
  • Jūsų sistema negauna duomenų: pasirinktas metodas GET, todėl duomenys yra URL adrese. Perjunkite į POST.
  • Trūksta lauko, kurio tikisi jūsų sistema: jis buvo tuščias arba sutikimas nebuvo pažymėtas. Sukonfigūruokite sistemą taip, kad trūkstamus laukus laikytų tuščiais.
Reikia pagalbos?

Vis dar reikia pagalbos?

Tikri žmonės pasiruošę padėti. Jei jau naudojate Scratcher, greičiausias būdas – pokalbis platformoje.

  • Rašykite mums

    Prisijunkite ir spustelėkite pokalbio mygtuką apačioje dešinėje. Rex atsako iš karto, o mūsų komanda – vos per vieną spustelėjimą.

  • Užsisakyti susitikimą

    Nemokamas 30 minučių vaizdo skambutis su mūsų komanda: apžvalga, kampanijų idėjos ar pagalba nustatant.

  • Parašykite mums el. laišką

    Rašykite adresu contact@scratcher.io ir mes jums atsakysime.