Preskoči na vsebino
Rex, vaš pomočnik UI: rutinsko delo opravi on, ideje so vaše 👉 Spoznajte Rexa

Pošiljajte podatke v svoje sisteme s spletnimi kljukami (webhooks)

Prejmite zahtevo na svoj URL, ko se nekdo registrira, sodeluje ali zmaga – s podpisano vsebino, osnovno avtentikacijo, vsebino po meri in dnevnikom vsake dostave.

Spletna kljuka (webhook) pošlje podatke na URL po vaši izbiri v trenutku, ko se nekaj zgodi, na primer ko nekdo sodeluje v kampanji ali zmaga nagrado. Sistem, ki podatke prejme, nastavi vaš razvijalec.

Spletne kljuke so del paketov, ki vključujejo Webhooks & API (Basic in višji).

Spletne kljuke kampanje ali računa?

  • Spletne kljuke kampanje nastavite v urejevalniku kampanje in se sprožijo samo za to kampanjo. Na voljo imajo dogodka »Every time a lead participates in a campaign« in »When a lead wins a prize« ter največ možnosti.
  • Spletne kljuke računa nastavite v Settings > Webhooks. Na voljo imajo dogodek »When a new lead is created«: sproži se enkrat na osebo, ko je prvič dodana med vaše leade, ne glede na to, iz katere kampanje prihaja.

Dodajanje spletne kljuke kampanji

  1. Odprite kampanjo v urejevalniku in pojdite na Connect > Webhooks.
  2. Kliknite Add webhook.
  3. Vnesite Payload URL. Začeti se mora s https: »We only support webhooks over HTTPS to ensure that the data sent remains secure.«
  4. Izberite Content type: application/json ali application/x-www-form-urlencoded.
  5. Izberite Method. Obrazec je privzeto nastavljen na GET, ki pošlje podatke v URL-ju. Izberite POST, da jih pošljete v telesu zahteve, kar pričakuje večina sistemov.
  6. Pod Authentication (samo za POST) izberite Basic Auth, če vaš URL zahteva uporabniško ime in geslo, ter izpolnite Username in Password. Sicer pustite None.
  7. Vnesite Secret za podpisovanje zahtev (priporočeno). Glejte »Preverjanje podpisa« spodaj.
  8. Vklopite Log response body, če želite videti, kaj odgovori vaš sistem. »Enable to store the response body for debugging.«
  9. Pustite vklopljeno Active. »We will only deliver events if the webhook is active.«
  10. Izberite dogodek: »Every time a lead participates in a campaign« ali »When a lead wins a prize«.
  11. Vklopite Custom payload, če želite polja določiti sami (glejte spodaj).
  12. Kliknite Add webhook. Prikaže se »Webhook added«.

Plošča Webhooks prikazuje spletne kljuke kampanje s statusom Active ali Inactive ter Last delivery failed, če zadnja zahteva ni uspela. Z Actions lahko spletno kljuko urejate (Edit), si ogledate dostave (See deliveries) ali jo izbrišete (Delete). Pri urejanju pustite Secret prazno, če želite obdržati obstoječo skrivnost.

Dodajanje spletne kljuke računa

  1. Pojdite na Settings > Webhooks (pod Developers). Vaše spletne kljuke so navedene pod My webhooks (ali pod imenom posameznega seznama leadov, če jih imate več).
  2. Kliknite kartico s plusom, da dodate spletno kljuko. Pogovorno okno Add webhook navaja »Send a request to an external URL whenever selected events happen.«
  3. Izpolnite Payload URL, Content type (»Select content type of the webhook«), Method in Secret kot zgoraj.
  4. Pod Which events should trigger the webhook? izberite »When a new lead is created«.
  5. Označite »Yes, allow me to specify a customized payload (Advanced users only)«, če želite lastna polja.
  6. Po potrebi označite Log response body (»This webhook will log the response body«) in pustite označeno Active (»We will deliver event details when this hook is triggered«).
  7. Kliknite Add webhook.

Kliknite spletno kljuko, da jo spremenite (Save changes), nastavite novo skrivnost (New secret), odprete Show deliveries ali jo izbrišete z Delete webhook (»This action cannot be reverted!«).

Kaj se pošlje

Privzeto telo vsebuje event (ime dogodka: lead_created_on_campaign, new_campaign_winner ali lead_created) in objekt data:

  • campaign: id in name kampanje (spletne kljuke kampanje)
  • lead: polja obrazca leada po ključu polja (na primer first_name) ter id, phone_number in created_at
  • lead.permissions: za vsako potrditveno polje privolitve – ali je bilo sprejeto, besedilo, datum in IP-naslov (spletne kljuke kampanje)
  • participant: channel, iz katerega je oseba prišla, in kdaj je sodelovala (spletne kljuke kampanje)
  • quiz: odgovori na poimenovana vprašanja kviza, tudi pod berljivimi imeni, ki se začnejo s »Simple«
  • prize: id, name, value, coupon_code nagrade in kdaj je bila osvojena (spletne kljuke za zmagovalce)

Prazne vrednosti se izpustijo, prav tako nesprejete privolitve. Pri metodi GET se isti podatki pošljejo kot parametri poizvedbe v URL-ju.

Vsebina po meri

Ko je vklopljeno Custom payload, se pošljejo samo izbrana polja, brez ovoja event.

  1. Pod Data mapping kliknite Add mapping.
  2. Vnesite Field name, ki ga pričakuje vaš sistem. Uporabite črke, številke, pomišljaje in podčrtaje.
  3. Izberite polje Scratcher, ki ga želite poslati (»Group → Field«), ali Custom value in vnesite fiksno vrednost (Value).
  4. Ponovite za vsako polje. Polje odstranite s koškom (Remove ali Remove data mapping).

Preverjanje podpisa

Če nastavite skrivnost, ima vsaka zahteva glavo X-Hub-Signature: sha1=, ki mu sledi zgoščena vrednost HMAC-SHA1 vsebine, kodirane v JSON (telo, kot je opisano zgoraj), pri čemer je ključ vaša skrivnost. Na svoji strani izračunajte enako vrednost in ju primerjajte, da se prepričate, da je zahteva prišla od Scratcherja.

Dostave in ponovni poskusi

  • Če vaš URL ne odgovori ali vrne napako (status 400 ali višji), Scratcher poskusi še dvakrat: po 5 sekundah in po eni minuti.
  • Preusmeritvam se ne sledi, zato uporabite končni URL.
  • Odprite dostave (See deliveries v kampanji, Show deliveries za spletne kljuke računa), da vidite vsako zahtevo in odgovor. Vsaka dostava prikazuje svoj ID, Request in Response s kodo statusa (ter Response body, če ga beležite). Z copy kopirate vsebino.
  • Vklopite Show only failed deliveries, da vidite samo težave. Na vrhu je prikazano »Failed deliveries in the last 60 days«.
  • Kliknite Retry, da dostavo pošljete znova: »The webhook is being resent.«
  • »Webhook delivery logs are retained for 60 days.«

Odpravljanje težav

  • »The ... field must use HTTPS.«: Payload URL se začne s http. Uporabite https.
  • Vse dostave spodletijo brez odgovora: URL ni dosegljiv z interneta, na primer lokalni ali interni naslov. Uporabite javni URL.
  • Vaš sistem ne prejme podatkov: metoda je GET, zato so podatki v URL-ju. Preklopite na POST.
  • Manjka polje, ki ga vaš sistem pričakuje: bilo je prazno ali privolitev ni bila sprejeta. Nastavite sistem tako, da manjkajoča polja obravnava kot prazna.
Potrebujete pomoč?

Še vedno potrebujete pomoč?

Pravi ljudje so tu, da vam pomagajo. Če Scratcher že uporabljate, je najhitrejša pot klepet v platformi.

  • Klepetajte z nami

    Prijavite se in kliknite gumb za klepet v spodnjem desnem kotu. Rex odgovori takoj, naša ekipa pa je le en klik stran.

  • Rezervirajte sestanek

    Brezplačen 30-minutni videoklic z našo ekipo: predstavitev, ideje za kampanje ali pomoč pri nastavitvi.

  • Pišite nam

    Pišite na contact@scratcher.io in odgovorili vam bomo.