Preskočiť na obsah
Rex, váš AI asistent: rutinu vybaví za vás, nápady ostávajú vaše 👉 Zoznámte sa s Rexom

Odosielajte dáta do svojich systémov cez webhooky

Keď sa niekto zaregistruje, zapojí alebo vyhrá, dostanete požiadavku na vlastnú URL – s podpísaným payloadom, základnou autentifikáciou, vlastným payloadom a záznamom každého doručenia.

Webhook odošle dáta na vami zvolenú URL v momente, keď sa niečo stane, napríklad keď sa niekto zapojí do kampane alebo vyhrá výhru. Systém, ktorý ich prijíma, nastaví váš vývojár.

Webhooky sú súčasťou plánov, ktoré obsahujú Webhooks & API (Basic a vyššie).

Webhooky kampane, alebo webhooky účtu?

  • Webhooky kampane sa nastavujú v editore kampane a spúšťajú sa len pre danú kampaň. Majú udalosti „Every time a lead participates in a campaign“ a „When a lead wins a prize“ a najviac možností.
  • Webhooky účtu sa nastavujú v časti Settings > Webhooks. Majú udalosť „When a new lead is created“: spustí sa raz na osobu, keď je prvýkrát pridaná medzi vaše leady, bez ohľadu na to, z ktorej kampane prišla.

Pridanie webhooku do kampane

  1. Otvorte kampaň v editore a prejdite do Connect > Webhooks.
  2. Kliknite na Add webhook.
  3. Zadajte Payload URL. Musí začínať na https: „We only support webhooks over HTTPS to ensure that the data sent remains secure.“
  4. Vyberte Content type: application/json alebo application/x-www-form-urlencoded.
  5. Vyberte Method. Formulár začína na GET, ktorý posiela dáta v URL. Zvoľte POST, ak ich chcete posielať v tele požiadavky – to väčšina systémov očakáva.
  6. V časti Authentication (len pri POST) zvoľte Basic Auth, ak vaša URL vyžaduje používateľské meno a heslo, a vyplňte Username a Password. Inak ponechajte None.
  7. Zadajte Secret na podpisovanie požiadaviek (odporúčame). Pozrite si časť „Overenie podpisu“ nižšie.
  8. Zapnite Log response body, ak chcete vidieť, čo váš systém odpovedá. „Enable to store the response body for debugging.“
  9. Nechajte zapnuté Active. „We will only deliver events if the webhook is active.“
  10. Vyberte udalosť: „Every time a lead participates in a campaign“ alebo „When a lead wins a prize“.
  11. Zapnite Custom payload, ak chcete polia určiť sami (pozrite nižšie).
  12. Kliknite na Add webhook. Zobrazí sa „Webhook added“.

Panel Webhooks zobrazuje webhooky kampane so stavom Active alebo Inactive a Last delivery failed, ak posledná požiadavka zlyhala. Cez Actions môžete webhook upraviť (Edit), zobraziť doručenia (See deliveries) alebo ho odstrániť (Delete). Pri úprave webhooku nechajte Secret prázdne, ak chcete ponechať súčasný.

Pridanie webhooku účtu

  1. Prejdite do Settings > Webhooks (v časti Developers). Vaše webhooky sú uvedené v My webhooks (alebo pod názvom každého zoznamu leadov, ak ich máte viac).
  2. Kliknite na kartu so znamienkom plus a pridajte webhook. Dialóg Add webhook uvádza „Send a request to an external URL whenever selected events happen.“
  3. Vyplňte Payload URL, Content type („Select content type of the webhook“), Method a Secret ako vyššie.
  4. V časti Which events should trigger the webhook? zvoľte „When a new lead is created“.
  5. Ak chcete vlastné polia, zaškrtnite „Yes, allow me to specify a customized payload (Advanced users only)“.
  6. V prípade potreby zaškrtnite Log response body („This webhook will log the response body“) a nechajte zaškrtnuté Active („We will deliver event details when this hook is triggered“).
  7. Kliknite na Add webhook.

Kliknutím na webhook ho môžete zmeniť (Save changes), nastaviť New secret, otvoriť Show deliveries alebo ho odstrániť cez Delete webhook („This action cannot be reverted!“).

Čo sa odosiela

Predvolene obsahuje telo event (názov udalosti: lead_created_on_campaign, new_campaign_winner alebo lead_created) a objekt data:

  • campaign: id a name kampane (webhooky kampane)
  • lead: polia formulára leadu podľa kľúča poľa (napríklad first_name), plus id, phone_number a created_at
  • lead.permissions: pri každom súhlasnom políčku, či bol súhlas udelený, text, dátum a IP adresa (webhooky kampane)
  • participant: channel, z ktorého osoba prišla, a kedy sa zapojila (webhooky kampane)
  • quiz: odpovede na pomenované otázky kvízu, aj pod čitateľnými názvami začínajúcimi na „Simple“
  • prize: id, name, value, coupon_code výhry a kedy bola vyhraná (webhooky výhercov)

Prázdne hodnoty sa vynechávajú, rovnako ako neudelené súhlasy. Pri metóde GET sa rovnaké dáta posielajú ako parametre dopytu v URL.

Vlastný payload

Keď je Custom payload zapnutý, odosielajú sa len vami zvolené polia a bez obalu event.

  1. V časti Data mapping kliknite na Add mapping.
  2. Zadajte Field name, ktorý váš systém očakáva. Používajte písmená, číslice, pomlčky a podčiarkovníky.
  3. Vyberte pole Scratcher, ktoré sa má odoslať („Group → Field“), alebo Custom value a zadajte pevnú hodnotu do Value.
  4. Zopakujte pre každé pole. Pole odstránite ikonou koša (Remove alebo Remove data mapping).

Overenie podpisu

Ak nastavíte secret, každá požiadavka obsahuje hlavičku X-Hub-Signature: sha1=, za ktorým nasleduje HMAC-SHA1 hash payloadu zakódovaného v JSON (telo, ako je opísané vyššie), s vaším secretom ako kľúčom. Vypočítajte to isté na svojej strane a porovnajte – tak si overíte, že požiadavka prišla zo Scratcher.

Doručenia a opakované pokusy

  • Ak vaša URL neodpovie alebo vráti chybu (stav 400 alebo vyšší), Scratcher to skúsi ešte dvakrát: po 5 sekundách a po minúte.
  • Presmerovania sa nesledujú, preto použite konečnú URL.
  • Otvorte doručenia (See deliveries v kampani, Show deliveries pri webhookoch účtu) a pozrite si každú požiadavku a odpoveď. Každé doručenie zobrazuje ID, Request a Response so stavovým kódom (a Response body, ak ho zaznamenávate). Payload skopírujete cez copy.
  • Zapnite Show only failed deliveries, ak chcete vidieť len problémy. V hornej časti sa zobrazuje „Failed deliveries in the last 60 days“.
  • Kliknutím na Retry doručenie odošlete znova: „The webhook is being resent.“
  • „Webhook delivery logs are retained for 60 days.“

Riešenie problémov

  • „The ... field must use HTTPS.“: Payload URL začína na http. Použite https.
  • Každé doručenie zlyhá bez odpovede: URL nie je dostupná z internetu, napríklad ide o lokálnu alebo internú adresu. Použite verejnú URL.
  • Váš systém nedostáva žiadne dáta: metóda je GET, takže dáta sú v URL. Prepnite na POST.
  • Chýba pole, ktoré váš systém očakáva: bolo prázdne alebo súhlas nebol udelený. Nastavte systém tak, aby chýbajúce polia považoval za prázdne.
Potrebujete pomôcť?

Stále potrebujete pomoc?

Skutoční ľudia sú tu, aby vám pomohli. Ak už Scratcher používate, najrýchlejšou cestou je chat priamo v platforme.

  • Napíšte nám do chatu

    Prihláste sa a kliknite na tlačidlo chatu v pravom dolnom rohu. Rex odpovie hneď a náš tím je len jedno kliknutie od vás.

  • Rezervovať stretnutie

    Bezplatný 30-minútový videohovor s naším tímom: prehliadka, nápady na kampane alebo pomoc s nastavením.

  • Napíšte nám e-mail

    Napíšte na contact@scratcher.io a ozveme sa vám.