Egy webhook üzenetet küld egy saját címre, valahányszor történik valami a munkaterületén, például amikor egy rendelést kifizetnek, vagy egy előfizetést lemondanak. Használja egy másik rendszer szinkronban tartásához, például egy olyan eszközhöz, mint a Zapier, a könyveléséhez vagy a saját szerveréhez.
A webhook-beállítások megnyitása
Mielőtt elkezdi
Az oldal a Fizetések > Beállítások > Webhookok alatt, a Fejlesztőknek csoportban található. A megtekintéséhez a Fizetések megtekintése kell. Végpontok hozzáadásához, módosításához, teszteléséhez és törléséhez a Rendelések / ügyfelek frissítése szükséges.
Végpont hozzáadása
Kattintson a hozzáadás gombra a Webhook-végpont hozzáadása megnyitásához:
- A Végpont alatt adjon neki egy opcionális Név értéket, és adja meg a Végpont-URL értékét. A címnek elérhetőnek kell lennie az internetről. A magánhálózatban lévő címeket a rendszer elutasítja.
- Az Események alatt válassza ki, mit kapjon a végpont. Az Események keresése szűkíti a listát, egy csoport jelölőnégyzete a teljes csoportot kijelöli, az Összes kijelölése vagy az Összes törlése pedig egyszerre mindent módosít. Legalább egy esemény kell.
- Kattintson a Létrehozás gombra.
Az események témák szerint vannak csoportosítva:
- Fizetések: Rendelés kifizetve, Fizetés folyamatban, Sikertelen fizetés, Számla kifizetve, Visszatérítés létrehozva.
- Előfizetések: Előfizetés létrehozva, Előfizetés megújítva, Előfizetés lemondva, Előfizetés fizetése sikertelen.
- Tagok: regisztrációk, bejelentkezések, hozzáadott vagy eltávolított címkék, módosított tagmezők és új kapcsolatok.
- Kurzusok és események, Közösség és Adatok és beérkezett üzenetek: befejezett kurzusok és leckék, eseményregisztrációk és részvétel, bejegyzések, szintek, jelvények, beérkezett üzenetek és jegyek.
- Partnerprogram: új jutalékok és teljesített kifizetések, lásd az affiliate súgót.
Az aláírási titok
Közvetlenül a végpont létrehozása után a munkaterület egyszer megmutatja az aláírási titkát: Másolja ki most az aláírási titkot. Tárolja a saját oldalán, majd kattintson a Kész gombra. Többé nem jelenik meg.
Minden kézbesítés JSON-ként érkezik az X-Maio-Signature fejléccel. Ez a nyers kéréstörzs
HMAC-SHA256 értékét tartalmazza, az Ön titkával készítve, kisbetűs hexadecimális karakterláncként.
Számítsa ki ugyanezt az értéket a saját oldalán, és hasonlítsa össze, így tudja, hogy az üzenet a
munkaterületéről érkezett. Az X-Maio-Event és az X-Maio-Delivery fejléc nevezi meg az
eseményt és a kézbesítést.
A titok cseréjéhez nyissa meg a végpontot, és kattintson a Titok cseréje gombra. A régi titok azonnal érvényét veszti, ezért azonnal frissítse a végpontját.
Tesztelés
Nyissa meg a végpontot, és kattintson a Teszt küldése gombra. A gomb Teszt sorba állítva feliratra vált, és néhány pillanaton belül egy tesztesemény érkezik a végpontjára. Ez a kézbesítési naplóban ugyanúgy megjelenik, mint bármely más kézbesítés.
A kézbesítési napló
A Kézbesítési napló fül minden kézbesítést listáz az Esemény, a Végpont, az Állapot, a végpont által visszaadott HTTP-állapot, a Próbálkozások és a Mikor adattal. Szűrje Kézbesítve, Sikertelen vagy Függőben szerint. Egy végpont Kézbesítések szakasza a 20 legutóbbi kézbesítését mutatja, minden sikertelennél a hibával.
Egy kézbesítés akkor számít kézbesítettnek, ha a végpont 15 másodpercen belül 2xx állapottal válaszol. Ellenkező esetben a rendszer 30 másodperc, 5 perc, 30 perc, 2 óra és 6 óra után újra próbálkozik. Az Újraküldés ugyanazzal a tartalommal újra elküld egy kézbesítést.
Ha egy eseménynél 20 egymást követő kísérlet sikertelen, az esemény kikapcsol a végpontnál. Ha a végpont 410 Gone válasszal felel, az esemény azonnal kikapcsol. Javítsa ki a végpontot, majd kapcsolja vissza Aktív állapotba.
Kikapcsolás és törlés
A végpontban a kapcsoló az Aktív és a Letiltva állapot között vált. Egy letiltott végpont semmit sem kap. A Törlés a megerősítés után az összes eseményével együtt eltávolítja.
Az API-ból
Az API-n keresztül csatlakoztatott alkalmazások a /api/v1/hooks végpontokkal és egy
webhooks:manage hatókörrel rendelkező API-kulccsal saját végpontokat állíthatnak be. Ezek
API jelvénnyel jelennek meg a listában, és itt csak a nevük és az állapotuk módosítható.
Nincs Titok cseréje és nincs Teszt küldése lehetőségük. Lásd:
API-kulcsok és fejlesztői hozzáférés.