WebHook Dokumentum
A WebHook funkció lehetővé teszi, hogy a Monitorozás.hu egy esemény bekövetkezésekor automatikusan HTTP POST kérést küldjön a megadott külső URL-re.
Ilyen esemény lehet például: device riasztás, blacklist állapotváltozás, értesítés sikeres vagy hibás kiküldése, illetve teszt esemény.
Minden webhook rekordhoz saját secret tartozik. A küldött kérés aláírása HMAC-SHA256 algoritmussal történik.
Ajánlott ellenőrzések:
- Bearer token vagy saját titkos azonosító ellenőrzése
- X-Webhook-Signature fejléc ellenőrzése
- JSON payload validálása
- Naplózás és hibaválasz kezelése
A Monitorozás.hu a webhook hívás során jellemzően az alábbi headereket küldi:
Megjegyzés:
- X-Webhook-Event az esemény típusát tartalmazza
- X-Webhook-Signature a payload HMAC-SHA256 aláírása
- az Authorization fejléc opcionális védelemként használható a fogadó oldalon
| Esemény kulcs | Jelentés |
|---|---|
device_alert_raised |
Device riasztás létrejött |
blacklist_listed |
Blacklistre került |
blacklist_cleared |
Blacklist helyreállás |
notification_sent |
Értesítés sikeresen kiküldve |
notification_failed |
Értesítés végleg sikertelen |
test.ping |
Teszt ping |
1. test.ping
2. device_alert_raised
3. blacklist_listed
4. blacklist_cleared
5. notification_sent
6. notification_failed
Egyszerű PHP webhook fogadó példa secret és aláírás ellenőrzéssel:
Egyszerű kézi teszt fogadó oldal ellenőrzéséhez:
A fogadó oldalnak siker esetén érdemes HTTP 200 választ adnia, például:
Ha a fogadó oldal nem 2xx státusszal válaszol, akkor a küldés sikertelennek minősül, és a rendszer retry logikát alkalmazhat.
- Mindig naplózd a nyers payloadot vagy annak kivonatát
- Ellenőrizd a signature-t minden kérésnél
- A fogadó oldalon legyen timeout és hibakezelés
- Idempotens feldolgozás javasolt, hogy ugyanaz az esemény többször se okozzon problémát
- Ha belső rendszerbe továbbítod, használj queue-t