Mine sisu juurde
Rex, teie AI-assistent: rutiin on tehtud, ideed jäävad teile 👉 Tutvuge Rexiga

Saatke andmeid oma süsteemidesse veebihaakidega

Saate päringu oma URL-ile, kui keegi registreerub, osaleb või võidab – allkirjastatud andmete, Basic Auth autentimise, kohandatud andmesisu ja iga saatmise logiga.

Veebihaak (webhook) saadab andmed teie valitud URL-ile kohe, kui midagi juhtub, näiteks kui keegi osaleb kampaanias või võidab auhinna. Andmeid vastuvõtva süsteemi seadistab teie arendaja.

Veebihaagid kuuluvad pakettidesse, mis sisaldavad funktsiooni Webhooks & API (Basic ja kõrgemad).

Kampaania või konto veebihaagid?

  • Kampaania veebihaagid seadistatakse kampaania redaktoris ja need käivituvad ainult selle kampaania puhul. Neil on sündmused „Every time a lead participates in a campaign“ ja „When a lead wins a prize“ ning kõige rohkem valikuid.
  • Konto veebihaagid seadistatakse jaotises Settings > Webhooks. Neil on sündmus „When a new lead is created“: see käivitub iga inimese kohta üks kord, kui ta esimest korda teie leadide hulka lisatakse, olenemata sellest, millisest kampaaniast ta tuli.

Veebihaagi lisamine kampaaniale

  1. Avage kampaania redaktoris ja minge jaotisse Connect > Webhooks.
  2. Klõpsake Add webhook.
  3. Sisestage Payload URL. See peab algama https-iga: „We only support webhooks over HTTPS to ensure that the data sent remains secure.“
  4. Valige Content type: application/json või application/x-www-form-urlencoded.
  5. Valige Method. Vaikimisi on valitud GET, mis saadab andmed URL-is. Valige POST, et saata need päringu sisus – seda ootab enamik süsteeme.
  6. Jaotises Authentication (ainult POST-i puhul) valige Basic Auth, kui teie URL nõuab kasutajanime ja parooli, ning täitke väljad Username ja Password. Muul juhul jätke valikuks None.
  7. Sisestage päringute allkirjastamiseks Secret (soovitatav). Vt allpool „Allkirja kontrollimine“.
  8. Lülitage sisse Log response body, kui soovite näha, mida teie süsteem vastab. „Enable to store the response body for debugging.“
  9. Jätke Active sisse. „We will only deliver events if the webhook is active.“
  10. Valige sündmus: „Every time a lead participates in a campaign“ või „When a lead wins a prize“.
  11. Lülitage sisse Custom payload, kui soovite välju ise määrata (vt allpool).
  12. Klõpsake Add webhook. Kuvatakse teade „Webhook added“.

Paneelil Webhooks on loetletud kampaania veebihaagid olekuga Active või Inactive ning märkega Last delivery failed, kui viimane päring ebaõnnestus. Menüüst Actions saate veebihaaki muuta (Edit), vaadata saatmisi (See deliveries) või selle kustutada (Delete). Veebihaagi muutmisel jätke väli Secret tühjaks, et praegune säiliks.

Konto veebihaagi lisamine

  1. Minge jaotisse Settings > Webhooks (rubriigis Developers). Teie veebihaagid on loetletud pealkirja My webhooks all (või iga leadide nimekirja nime all, kui teil on neid mitu).
  2. Veebihaagi lisamiseks klõpsake plussmärgiga kaarti. Dialoogis Add webhook on kirjas „Send a request to an external URL whenever selected events happen.“
  3. Täitke väljad Payload URL, Content type („Select content type of the webhook“), Method ja Secret nagu eespool.
  4. Jaotises Which events should trigger the webhook? valige „When a new lead is created“.
  5. Märkige „Yes, allow me to specify a customized payload (Advanced users only)“, kui soovite kasutada oma välju.
  6. Vajadusel märkige Log response body („This webhook will log the response body“) ja jätke Active märgituks („We will deliver event details when this hook is triggered“).
  7. Klõpsake Add webhook.

Klõpsake veebihaagil, et seda muuta (Save changes), määrata uus salajane võti (New secret), avada saatmised (Show deliveries) või see kustutada (Delete webhook; „This action cannot be reverted!“).

Mida saadetakse

Vaikimisi sisaldab päringu sisu välja event (sündmuse nimi: lead_created_on_campaign, new_campaign_winner või lead_created) ja objekti data:

  • campaign: kampaania id ja name (kampaania veebihaagid)
  • lead: leadi vormiväljad nende väljavõtme järgi (näiteks first_name), lisaks id, phone_number ja created_at
  • lead.permissions: iga nõusolekumärkeruudu kohta see, kas see aktsepteeriti, tekst, kuupäev ja IP-aadress (kampaania veebihaagid)
  • participant: kanal (channel), kust inimene tuli, ja millal ta osales (kampaania veebihaagid)
  • quiz: vastused nimega viktoriiniküsimustele, ka loetavate nimede all, mis algavad sõnaga „Simple“
  • prize: auhinna id, name, value, coupon_code ja võitmise aeg (võitjate veebihaagid)

Tühjad väärtused jäetakse välja, samuti nõusolekud, mida ei aktsepteeritud. GET-meetodi puhul saadetakse samad andmed URL-is päringuparameetritena.

Kohandatud andmesisu

Kui Custom payload on sisse lülitatud, saadetakse ainult teie valitud väljad ja event-ümbrist ei kasutata.

  1. Jaotises Data mapping klõpsake Add mapping.
  2. Sisestage Field name, mida teie süsteem ootab. Kasutage tähti, numbreid, sidekriipse ja allkriipse.
  3. Valige saadetav Scratcheri väli („Group → Field“) või Custom value ja sisestage fikseeritud Value.
  4. Korrake iga välja puhul. Välja eemaldamiseks klõpsake prügikasti ikooni (Remove või Remove data mapping).

Allkirja kontrollimine

Kui olete määranud salajase võtme, on igal päringul päis X-Hub-Signature: sha1=, millele järgneb JSON-kodeeritud andmesisu (eespool kirjeldatud päringu sisu) HMAC-SHA1 räsi, mille võtmeks on teie salajane võti. Arvutage oma poolel sama räsi ja võrrelge, et olla kindel, et päring tuli Scratcherilt.

Saatmised ja kordused

  • Kui teie URL ei vasta või tagastab vea (olekukood 400 või kõrgem), proovib Scratcher veel kaks korda: 5 sekundi ja ühe minuti pärast.
  • Ümbersuunamisi ei järgita, seega kasutage lõplikku URL-i.
  • Avage saatmised (kampaanias See deliveries, konto veebihaakide puhul Show deliveries), et näha iga päringut ja vastust. Iga saatmise juures on kuvatud selle ID, Request ja Response koos olekukoodiga (ning Response body, kui seda logite). Andmesisu kopeerimiseks kasutage nuppu copy.
  • Lülitage sisse Show only failed deliveries, et näha ainult probleeme. Ülaosas kuvatakse „Failed deliveries in the last 60 days“.
  • Saatmise kordamiseks klõpsake Retry: „The webhook is being resent.“
  • „Webhook delivery logs are retained for 60 days.“

Tõrkeotsing

  • „The ... field must use HTTPS.“: Payload URL algab http-ga. Kasutage https-i.
  • Kõik saatmised ebaõnnestuvad ilma vastuseta: URL ei ole internetist kättesaadav, näiteks on tegu kohaliku või sisevõrgu aadressiga. Kasutage avalikku URL-i.
  • Teie süsteem ei saa andmeid: meetodiks on GET, seega on andmed URL-is. Valige POST.
  • Väli, mida teie süsteem ootab, puudub: see oli tühi või nõusolekut ei aktsepteeritud. Seadistage süsteem käsitlema puuduvaid välju tühjadena.
Vajate abi?

Vajate ikka abi?

Päris inimesed on siin, et aidata. Kui juba kasutate Scratcherit, on kiireim viis platvormisisene vestlus.

  • Vestelge meiega

    Logige sisse ja klõpsake paremas alanurgas vestlusnuppu. Rex vastab kohe ja meie meeskond on ühe klõpsu kaugusel.

  • Broneeri kohtumine

    Tasuta 30-minutiline videokõne meie meeskonnaga: ringkäik, kampaaniaideed või abi seadistamisel.

  • Kirjutage meile

    Kirjutage aadressil contact@scratcher.io ja me vastame teile.