A webhook abban a pillanatban adatokat küld egy Ön által választott URL-re, amikor valami történik, például amikor valaki részt vesz egy kampányban vagy nyereményt nyer. A fogadó rendszert az Ön fejlesztője állítja be.
A webhookok azoknak a csomagoknak a részei, amelyek tartalmazzák a Webhooks & API funkciót (Basic csomagtól felfelé).
Kampány-webhookok vagy fiók-webhookok?
- A kampány-webhookokat a kampányszerkesztőben állíthatja be, és csak az adott kampánynál aktiválódnak. Ezek eseményei: „Minden alkalommal, amikor egy lead részt vesz egy kampányban” és „Amikor egy lead nyereményt nyer”, és ezek kínálják a legtöbb beállítási lehetőséget.
- A fiók-webhookokat a Beállítások > Webhookok menüpontban állíthatja be. Eseményük: „Amikor új lead jön létre”: személyenként egyszer aktiválódik, amikor az illető először bekerül a leadjei közé, függetlenül attól, melyik kampányból érkezett.
Webhook hozzáadása egy kampányhoz
- Nyissa meg a kampányt a szerkesztőben, és lépjen a Kapcsolódás > Webhookok részre.
- Kattintson a Webhook hozzáadása gombra.
- Adja meg a Payload URL-t. Ennek https-sel kell kezdődnie: „Csak HTTPS-en keresztüli webhookokat támogatunk, hogy a küldött adatok biztonságban maradjanak.”
- Válassza ki a Tartalomtípust: application/json vagy application/x-www-form-urlencoded.
- Válassza ki a Metódust. Az űrlap alapértelmezése a GET, amely az URL-ben küldi az adatokat. Válassza a POST lehetőséget, ha a kérés törzsében szeretné küldeni őket – a legtöbb rendszer ezt várja.
- A Hitelesítés résznél (csak POST esetén) válassza a Basic Auth lehetőséget, ha az URL felhasználónevet és jelszót igényel, majd töltse ki a Felhasználónév és a Jelszó mezőt. Ellenkező esetben hagyja a Nincs beállítást.
- Adjon meg egy Titkos kulcsot a kérések aláírásához (ajánlott). Lásd lent: „Az aláírás ellenőrzése”.
- Kapcsolja be a Válasz törzsének naplózása opciót, ha látni szeretné, mit válaszol a rendszere. „Engedélyezze a válasz törzsének tárolásához hibakereséshez.”
- Hagyja bekapcsolva az Aktív opciót. „Csak akkor kézbesítünk eseményeket, ha a webhook aktív.”
- Válassza ki az eseményt: „Minden alkalommal, amikor egy lead részt vesz egy kampányban” vagy „Amikor egy lead nyereményt nyer”.
- Kapcsolja be az Egyéni payload opciót, ha saját maga szeretné meghatározni a mezőket (lásd lent).
- Kattintson a Webhook hozzáadása gombra. Megjelenik a „Webhook hozzáadva” üzenet.
A Webhookok panel felsorolja a kampány webhookjait Aktív vagy Inaktív állapottal, valamint Az utolsó kézbesítés sikertelen jelzéssel, ha a legutóbbi kérés nem sikerült. A Műveletek menüben Szerkesztheti, megnyithatja a Kézbesítések megtekintése nézetet, vagy Törölheti a webhookot. Szerkesztéskor hagyja üresen a Titkos kulcs mezőt, ha meg szeretné tartani a meglévőt.
Fiók-webhook hozzáadása
- Lépjen a Beállítások > Webhookok menüpontra (a Fejlesztők alatt). Webhookjai a Saját webhookok alatt találhatók (vagy több leadlista esetén az egyes listák neve alatt).
- Kattintson a pluszjeles kártyára új webhook hozzáadásához. A Webhook hozzáadása párbeszédablakban ez áll: „Kérés küldése külső URL-re, amikor a kiválasztott események bekövetkeznek.”
- Töltse ki a Payload URL, a Tartalomtípus („Válassza ki a webhook tartalomtípusát”), a Metódus és a Titkos kulcs mezőt a fentiek szerint.
- Mely események aktiválják a webhookot? résznél válassza a „Amikor új lead jön létre” lehetőséget.
- Jelölje be az „Igen, egyéni payloadot szeretnék megadni (csak haladó felhasználóknak)” opciót, ha saját mezőket szeretne.
- Szükség esetén jelölje be a Válasz törzsének naplózása opciót („Ez a webhook naplózza a válasz törzsét”), és hagyja bejelölve az Aktív opciót („Az esemény részleteit kézbesítjük, amikor ez a hook aktiválódik”).
- Kattintson a Webhook hozzáadása gombra.
Egy webhookra kattintva módosíthatja azt (Módosítások mentése), beállíthat Új titkos kulcsot, megnyithatja a Kézbesítések megjelenítése nézetet, vagy használhatja a Webhook törlése lehetőséget („Ez a művelet nem vonható vissza!”).
Mit küldünk?
Alapértelmezés szerint a törzs egy event mezőt (az esemény nevét: lead_created_on_campaign, new_campaign_winner vagy lead_created) és egy data objektumot tartalmaz:
campaign: a kampányidésnameértéke (kampány-webhookok)lead: a lead űrlapmezői a mezőkulcsuk szerint (példáulfirst_name), valamintid,phone_numberéscreated_atlead.permissions: minden hozzájárulási jelölőnégyzetnél, hogy elfogadták-e, a szöveg, a dátum és az IP-cím (kampány-webhookok)participant: achannel, ahonnan a személy érkezett, és a részvétel időpontja (kampány-webhookok)quiz: az elnevezett kvízkérdésekre adott válaszok, „Simple” kezdetű olvasható neveken isprize: a nyereményid,name,value,coupon_codeértéke és a nyerés időpontja (nyertes-webhookok)
Az üres értékek kimaradnak, ahogy a nem elfogadott hozzájárulások is. GET metódus esetén ugyanezeket az adatokat lekérdezési paraméterekként küldjük az URL-ben.
Egyéni payload
Bekapcsolt Egyéni payload esetén csak az Ön által kiválasztott mezőket küldjük, event burkoló nélkül.
- Az Adatleképezés résznél kattintson a Leképezés hozzáadása gombra.
- Írja be a rendszere által várt Mezőnevet. Betűket, számokat, kötőjeleket és aláhúzásjeleket használhat.
- Válassza ki a küldendő Scratcher-mezőt („Csoport → Mező”), vagy az Egyéni érték lehetőséget, és írjon be egy rögzített Értéket.
- Ismételje meg minden mezőnél. Egy mezőt a kuka ikonnal távolíthat el (Eltávolítás vagy Adatleképezés eltávolítása).
Az aláírás ellenőrzése
Ha megadott titkos kulcsot, minden kérés tartalmaz egy X-Hub-Signature fejlécet: sha1=, amelyet a JSON-kódolt payload (a fent leírt törzs) HMAC-SHA1 hash-e követ, kulcsként az Ön titkos kulcsát használva. Számítsa ki ugyanezt a saját oldalán, és hasonlítsa össze – így biztos lehet benne, hogy a kérés a Scratchertől érkezett.
Kézbesítések és újrapróbálkozások
- Ha az URL nem válaszol, vagy hibát ad vissza (400-as vagy magasabb állapotkód), a Scratcher még kétszer próbálkozik: 5 másodperc és egy perc elteltével.
- Az átirányításokat nem követjük, ezért a végleges URL-t használja.
- Nyissa meg a kézbesítéseket (kampányban Kézbesítések megtekintése, fiók-webhookoknál Kézbesítések megjelenítése), hogy lássa az egyes kéréseket és válaszokat. Minden kézbesítésnél látható az Azonosító, a Kérés és a Válasz az állapotkóddal (valamint a Válasz törzse, ha naplózza). A másolás gombbal kimásolhatja a payloadot.
- Kapcsolja be a Csak a sikertelen kézbesítések megjelenítése opciót, hogy csak a problémákat lássa. Felül a „Sikertelen kézbesítések az elmúlt 60 napban” felirat látható.
- Kattintson az Újrapróbálás gombra egy kézbesítés ismételt elküldéséhez: „A webhook újraküldése folyamatban.”
- „A webhook-kézbesítési naplókat 60 napig őrizzük meg.”
Hibaelhárítás
- „A(z) ... mezőnek HTTPS-t kell használnia.”: a Payload URL http-vel kezdődik. Használjon https-t.
- Minden kézbesítés válasz nélkül meghiúsul: az URL nem érhető el az internetről, például helyi vagy belső címről van szó. Használjon nyilvános URL-t.
- A rendszere nem kap adatot: a metódus GET, így az adatok az URL-ben vannak. Váltson POST-ra.
- Hiányzik egy mező, amelyet a rendszere vár: üres volt, vagy a hozzájárulást nem fogadták el. Állítsa be a rendszerét úgy, hogy a hiányzó mezőket üresként kezelje.