Pāriet uz saturu
Rex, jūsu MI asistents: rutīnu paveic viņš, idejas paliek jūsu 👉 Iepazīstieties ar Rex

Sūtiet datus uz savām sistēmām ar tīmekļa āķiem (webhooks)

Saņemiet pieprasījumu uz savu URL, kad kāds reģistrējas, piedalās vai uzvar, ar parakstītu datu paketi, pamata autentifikāciju, pielāgotu datu paketi un katras piegādes žurnālu.

Tīmekļa āķis (webhook) nosūta datus uz jūsu izvēlētu URL brīdī, kad kaut kas notiek, piemēram, kad kāds piedalās kampaņā vai laimē balvu. Sistēmu, kas tos saņem, iestata jūsu izstrādātājs.

Tīmekļa āķi ir pieejami plānos, kuros ietilpst Webhooks & API (Basic un augstākos).

Kampaņas vai konta tīmekļa āķi?

  • Kampaņas tīmekļa āķi tiek iestatīti kampaņas redaktorā un darbojas tikai konkrētajai kampaņai. Tiem ir notikumi „Every time a lead participates in a campaign” un „When a lead wins a prize”, kā arī visplašākās iespējas.
  • Konta tīmekļa āķi tiek iestatīti sadaļā Settings > Webhooks. Tiem ir notikums „When a new lead is created”: tas tiek aktivizēts vienreiz katrai personai, kad tā pirmo reizi tiek pievienota jūsu potenciālajiem klientiem, neatkarīgi no tā, no kuras kampaņas tā nākusi.

Tīmekļa āķa pievienošana kampaņai

  1. Atveriet kampaņu redaktorā un dodieties uz Connect > Webhooks.
  2. Noklikšķiniet uz Add webhook.
  3. Ievadiet Payload URL. Tam jāsākas ar https: „We only support webhooks over HTTPS to ensure that the data sent remains secure.”
  4. Izvēlieties Content type: application/json vai application/x-www-form-urlencoded.
  5. Izvēlieties Method. Veidlapā pēc noklusējuma ir GET, kas nosūta datus URL adresē. Izvēlieties POST, lai tos nosūtītu pieprasījuma pamattekstā – to sagaida lielākā daļa sistēmu.
  6. Sadaļā Authentication (tikai POST metodei) izvēlieties Basic Auth, ja jūsu URL nepieciešams lietotājvārds un parole, un aizpildiet laukus Username un Password. Pretējā gadījumā atstājiet None.
  7. Ievadiet Secret, lai parakstītu pieprasījumus (ieteicams). Skatiet sadaļu „Paraksta pārbaude” zemāk.
  8. Ieslēdziet Log response body, ja vēlaties redzēt, ko atbild jūsu sistēma. „Enable to store the response body for debugging.”
  9. Atstājiet ieslēgtu Active. „We will only deliver events if the webhook is active.”
  10. Izvēlieties notikumu: „Every time a lead participates in a campaign” vai „When a lead wins a prize”.
  11. Ieslēdziet Custom payload, ja vēlaties laukus noteikt paši (skatiet zemāk).
  12. Noklikšķiniet uz Add webhook. Parādīsies paziņojums „Webhook added”.

Panelī Webhooks ir redzami kampaņas tīmekļa āķi ar statusu Active vai Inactive, kā arī Last delivery failed, ja pēdējais pieprasījums neizdevās. Izmantojiet Actions, lai tīmekļa āķi rediģētu (Edit), skatītu piegādes (See deliveries) vai dzēstu (Delete). Rediģējot tīmekļa āķi, atstājiet lauku Secret tukšu, lai saglabātu esošo.

Konta tīmekļa āķa pievienošana

  1. Dodieties uz Settings > Webhooks (sadaļā Developers). Jūsu tīmekļa āķi ir uzskaitīti sadaļā My webhooks (vai zem katra potenciālo klientu saraksta nosaukuma, ja jums tādu ir vairāki).
  2. Noklikšķiniet uz kartītes ar plus zīmi, lai pievienotu tīmekļa āķi. Dialoglodziņā Add webhook ir rakstīts „Send a request to an external URL whenever selected events happen.”
  3. Aizpildiet laukus Payload URL, Content type („Select content type of the webhook”), Method un Secret, kā aprakstīts iepriekš.
  4. Sadaļā Which events should trigger the webhook? izvēlieties „When a new lead is created”.
  5. Atzīmējiet „Yes, allow me to specify a customized payload (Advanced users only)”, ja vēlaties izmantot savus laukus.
  6. Ja nepieciešams, atzīmējiet Log response body („This webhook will log the response body”) un atstājiet atzīmētu Active („We will deliver event details when this hook is triggered”).
  7. Noklikšķiniet uz Add webhook.

Noklikšķiniet uz tīmekļa āķa, lai to mainītu (Saglabāt izmaiņas), iestatītu jaunu noslēpumu (New secret), atvērtu Show deliveries vai dzēstu ar Delete webhook („This action cannot be reverted!”).

Kas tiek nosūtīts

Pēc noklusējuma pamattekstā ir event (notikuma nosaukums: lead_created_on_campaign, new_campaign_winner vai lead_created) un data objekts:

  • campaign: kampaņas id un name (kampaņas tīmekļa āķiem)
  • lead: potenciālā klienta veidlapas lauki pēc to lauka atslēgas (piemēram, first_name), kā arī id, phone_number un created_at
  • lead.permissions: par katru piekrišanas izvēles rūtiņu – vai tā tika apstiprināta, teksts, datums un IP adrese (kampaņas tīmekļa āķiem)
  • participant: channel, no kura persona ieradās, un laiks, kad tā piedalījās (kampaņas tīmekļa āķiem)
  • quiz: atbildes uz nosauktajiem viktorīnas jautājumiem, arī ar viegli lasāmiem nosaukumiem, kas sākas ar „Simple”
  • prize: balvas id, name, value, coupon_code un laiks, kad tā tika laimēta (uzvarētāju tīmekļa āķiem)

Tukšas vērtības netiek iekļautas, tāpat kā neapstiprinātas piekrišanas. Izmantojot GET metodi, tie paši dati tiek nosūtīti kā vaicājuma parametri URL adresē.

Pielāgota datu pakete

Kad ieslēgts Custom payload, tiek nosūtīti tikai jūsu izvēlētie lauki, un nav event ietvara.

  1. Sadaļā Data mapping noklikšķiniet uz Add mapping.
  2. Ierakstiet Field name, ko sagaida jūsu sistēma. Izmantojiet burtus, ciparus, defises un pasvītras.
  3. Izvēlieties nosūtāmo Scratcher lauku („Group → Field”) vai Custom value un ierakstiet fiksētu Value.
  4. Atkārtojiet katram laukam. Lai kādu noņemtu, izmantojiet miskastes ikonu (Remove vai Remove data mapping).

Paraksta pārbaude

Ja esat iestatījuši noslēpumu, katram pieprasījumam ir galvene X-Hub-Signature: sha1=, kam seko JSON formātā kodētas datu paketes (iepriekš aprakstītā pamatteksta) HMAC-SHA1 jaucējvērtība, izmantojot jūsu noslēpumu kā atslēgu. Aprēķiniet to pašu savā pusē un salīdziniet, lai pārliecinātos, ka pieprasījums nāk no Scratcher.

Piegādes un atkārtoti mēģinājumi

  • Ja jūsu URL neatbild vai atgriež kļūdu (statuss 400 vai augstāks), Scratcher mēģina vēl divas reizes: pēc 5 sekundēm un pēc minūtes.
  • Pāradresācijām netiek sekots, tāpēc izmantojiet galīgo URL.
  • Atveriet piegādes (See deliveries kampaņā, Show deliveries konta tīmekļa āķiem), lai redzētu katru pieprasījumu un atbildi. Katrai piegādei ir redzams tās ID, Request un Response ar statusa kodu (un Response body, ja to reģistrējat). Izmantojiet copy, lai kopētu datu paketi.
  • Ieslēdziet Show only failed deliveries, lai redzētu tikai problēmas. Augšpusē ir redzams „Failed deliveries in the last 60 days”.
  • Noklikšķiniet uz Retry, lai piegādi nosūtītu vēlreiz: „The webhook is being resent.”
  • „Webhook delivery logs are retained for 60 days.”

Problēmu novēršana

  • „The ... field must use HTTPS.”: Payload URL sākas ar http. Izmantojiet https.
  • Visas piegādes neizdodas bez atbildes: URL nav sasniedzams no interneta, piemēram, tā ir lokāla vai iekšēja adrese. Izmantojiet publisku URL.
  • Jūsu sistēma nesaņem datus: metode ir GET, tāpēc dati ir URL adresē. Pārslēdziet uz POST.
  • Trūkst lauka, ko sagaida jūsu sistēma: tas bija tukšs vai piekrišana netika apstiprināta. Konfigurējiet sistēmu tā, lai trūkstošos laukus tā uzskatītu par tukšiem.
Vajadzīga palīdzība?

Joprojām vajadzīga palīdzība?

Īsti cilvēki ir gatavi palīdzēt. Ja jau izmantojat Scratcher, ātrākais veids ir tērzēšana platformā.

  • Tērzējiet ar mums

    Piesakieties un noklikšķiniet uz tērzēšanas pogas apakšējā labajā stūrī. Rex atbild uzreiz, un mūsu komanda ir viena klikšķa attālumā.

  • Rezervēt tikšanos

    Bezmaksas 30 minūšu videozvans ar mūsu komandu: platformas apskats, kampaņu idejas vai palīdzība ar iestatīšanu.

  • Rakstiet mums

    Rakstiet uz contact@scratcher.io, un mēs jums atbildēsim.