Preskoči na sadržaj
Rex, vaš AI asistent: rutinu preuzima on, ideje su vaše 👉 Upoznajte Rexa

Šaljite podatke u svoje sustave putem webhookova

Primite zahtjev na vlastiti URL kada se netko registrira, sudjeluje ili osvoji nagradu, uz potpisani sadržaj, osnovnu autentifikaciju, prilagođeni sadržaj i zapis svake isporuke.

Webhook šalje podatke na URL koji odaberete u trenutku kada se nešto dogodi, primjerice kada netko sudjeluje u kampanji ili osvoji nagradu. Vaš programer postavlja sustav koji ih prima.

Webhookovi su dio paketa koji uključuju Webhooks & API (Basic i viši).

Webhookovi kampanje ili webhookovi računa?

  • Webhookovi kampanje postavljaju se u uređivaču kampanje i aktiviraju se samo za tu kampanju. Imaju događaje „Every time a lead participates in a campaign” i „When a lead wins a prize” te najviše mogućnosti.
  • Webhookovi računa postavljaju se pod Settings > Webhooks. Imaju događaj „When a new lead is created”: aktivira se jednom po osobi, kada je prvi put dodana među vaše leadove, bez obzira na to iz koje kampanje dolazi.

Dodavanje webhooka kampanji

  1. Otvorite kampanju u uređivaču i idite na Connect > Webhooks.
  2. Kliknite Add webhook.
  3. Unesite Payload URL. Mora počinjati s https: „We only support webhooks over HTTPS to ensure that the data sent remains secure.”
  4. Odaberite Content type: application/json ili application/x-www-form-urlencoded.
  5. Odaberite Method. Obrazac je zadano postavljen na GET, koji šalje podatke u URL-u. Odaberite POST kako biste ih slali u tijelu zahtjeva, što očekuje većina sustava.
  6. Pod Authentication (samo za POST) odaberite Basic Auth ako vaš URL zahtijeva korisničko ime i lozinku te ispunite Username i Password. U suprotnom ostavite None.
  7. Unesite Secret za potpisivanje zahtjeva (preporučeno). Pogledajte „Provjera potpisa” u nastavku.
  8. Uključite Log response body ako želite vidjeti što vaš sustav odgovara. „Enable to store the response body for debugging.”
  9. Ostavite Active uključeno. „We will only deliver events if the webhook is active.”
  10. Odaberite događaj: „Every time a lead participates in a campaign” ili „When a lead wins a prize”.
  11. Uključite Custom payload ako sami želite odrediti polja (pogledajte u nastavku).
  12. Kliknite Add webhook. Prikazat će se „Webhook added”.

Ploča Webhooks prikazuje webhookove kampanje sa statusom Active ili Inactive te Last delivery failed ako posljednji zahtjev nije uspio. Putem Actions možete webhook urediti (Edit), pregledati isporuke (See deliveries) ili ga izbrisati (Delete). Kada uređujete webhook, ostavite Secret prazno kako biste zadržali postojeći.

Dodavanje webhooka računa

  1. Idite na Settings > Webhooks (pod Developers). Vaši webhookovi navedeni su pod My webhooks (ili pod nazivom svakog popisa leadova, ako ih imate više).
  2. Kliknite karticu s plusom kako biste dodali webhook. Dijalog Add webhook navodi „Send a request to an external URL whenever selected events happen.”
  3. Ispunite Payload URL, Content type („Select content type of the webhook”), Method i Secret kao gore.
  4. Pod Which events should trigger the webhook? odaberite „When a new lead is created”.
  5. Označite „Yes, allow me to specify a customized payload (Advanced users only)” ako želite vlastita polja.
  6. Po potrebi označite Log response body („This webhook will log the response body”) i ostavite Active označeno („We will deliver event details when this hook is triggered”).
  7. Kliknite Add webhook.

Kliknite webhook kako biste ga izmijenili (Save changes), postavili novu tajnu (New secret), otvorili Show deliveries ili ga izbrisali putem Delete webhook („This action cannot be reverted!”).

Što se šalje

Zadano tijelo zahtjeva sadrži event (naziv događaja: lead_created_on_campaign, new_campaign_winner ili lead_created) i objekt data:

  • campaign: id i name kampanje (webhookovi kampanje)
  • lead: polja obrasca leada prema ključu polja (primjerice first_name), uz id, phone_number i created_at
  • lead.permissions: za svaki potvrdni okvir privole – je li prihvaćen, tekst, datum i IP adresa (webhookovi kampanje)
  • participant: channel iz kojeg je osoba došla i kada je sudjelovala (webhookovi kampanje)
  • quiz: odgovori na imenovana pitanja kviza, također pod čitljivim nazivima koji počinju sa „Simple”
  • prize: id, name, value, coupon_code nagrade i kada je osvojena (webhookovi za dobitnike)

Prazne vrijednosti se izostavljaju, kao i neprihvaćene privole. Kod metode GET isti se podaci šalju kao parametri upita u URL-u.

Prilagođeni sadržaj

Kada je Custom payload uključen, šalju se samo polja koja odaberete, bez omotača event.

  1. Pod Data mapping kliknite Add mapping.
  2. Upišite Field name koji vaš sustav očekuje. Koristite slova, brojeve, crtice i podvlake.
  3. Odaberite Scratcher polje koje želite poslati („Group → Field”) ili Custom value i upišite fiksnu vrijednost (Value).
  4. Ponovite za svako polje. Polje uklonite ikonom koša (Remove ili Remove data mapping).

Provjera potpisa

Ako ste postavili tajnu, svaki zahtjev sadrži zaglavlje X-Hub-Signature: sha1= iza kojeg slijedi HMAC-SHA1 hash JSON-kodiranog sadržaja (tijelo opisano gore), s vašom tajnom kao ključem. Izračunajte isto na svojoj strani i usporedite kako biste bili sigurni da zahtjev dolazi od Scratchera.

Isporuke i ponovni pokušaji

  • Ako vaš URL ne odgovori ili vrati pogrešku (status 400 ili viši), Scratcher pokušava ponovno još dvaput: nakon 5 sekundi i nakon jedne minute.
  • Preusmjeravanja se ne prate, stoga koristite konačni URL.
  • Otvorite isporuke (See deliveries u kampanji, Show deliveries za webhookove računa) kako biste vidjeli svaki zahtjev i odgovor. Svaka isporuka prikazuje svoj ID, Request i Response sa statusnim kodom (te Response body ako ga bilježite). Pomoću copy kopirajte sadržaj.
  • Uključite Show only failed deliveries kako biste vidjeli samo probleme. Na vrhu se prikazuje „Failed deliveries in the last 60 days”.
  • Kliknite Retry kako biste ponovno poslali isporuku: „The webhook is being resent.”
  • „Webhook delivery logs are retained for 60 days.”

Rješavanje problema

  • „The ... field must use HTTPS.”: Payload URL počinje s http. Koristite https.
  • Svaka isporuka ne uspijeva i nema odgovora: URL nije dostupan s interneta, primjerice lokalna ili interna adresa. Koristite javni URL.
  • Vaš sustav ne prima podatke: metoda je GET, pa su podaci u URL-u. Prebacite na POST.
  • Nedostaje polje koje vaš sustav očekuje: bilo je prazno ili privola nije prihvaćena. Podesite sustav da polja koja nedostaju tretira kao prazna.
Trebate pomoć?

I dalje trebate pomoć?

Stvarni ljudi tu su da pomognu. Ako već koristite Scratcher, najbrži je put chat u platformi.

  • Razgovarajte s nama

    Prijavite se i kliknite gumb za chat u donjem desnom kutu. Rex odgovara odmah, a naš tim udaljen je samo jedan klik.

  • Rezervirajte sastanak

    Besplatan 30-minutni videopoziv s našim timom: obilazak, ideje za kampanje ili pomoć s postavljanjem.

  • Pišite nam

    Pišite na contact@scratcher.io i javit ćemo vam se.