Webhookok

A WebHook egy olyan mechanizmus, amellyel a rendszer értesíthető bizonyos eseményekről, Amikor például egy esemény bekövetkezik a KOMPaaS-ban, a webhook lekéri annak címét és paramétereit, majd továbbítja egy külső alkalmazásnak.

Általában a "HTTP callbacks-t" valamilyen esemény váltja ki, például egy másik belső előfizetőnek átirányított, vagy egy virtuális telefonközpontba bejövő hívás. Amikor ez az esemény bekövetkezik, a kezdeményező webhely HTTP-kérést küld a webhookhoz megadott URL-címre. A felhasználók úgy konfigurálhatják őket, hogy az egyik webhelyen bekövetkező események egy másik webhelyen akciókat indítsanak el.

Webhook létrehozásához a KOMPaaS felületén lépjen az "Integrációk" szekcióban a >> "WebHookok" fülre, és kattintson az "Új webhook" gombra.

A felugró modális ablakban válassza ki a webhook esemény típusát, majd kattintson a "Létrehozni" gombra.

A leggyakoribb eseménytípusok, amelyekhez létrehozhat egy webhookot, a következők:

• Telefonhívások (bejövő, kimenő hívások, hívásválasz, hívás kezdete/befejezése stb.).
• Virtuális alközpont-hívások;
• Hitelesítési hívások (Password call, Flash call stb.);
• SMS;
• Híváskövetés;
• Automatikus hívások;

Az események teljes listája megtekinthető a webhook létrehozásának ablakában. Létrehozás után a webhook feliratkozik a szükséges eseményre, és az esemény bekövetkezésekor kérést küld a megadott címre.

Webhook beállítások mezői

1. Cím - a webhook neve.
2. URL - a cím, amelyre a webhook elküldésre kerül.
3. Retry if error - alapértelmezés szerint ez a funkció engedélyezve van. Ha a jelölőnégyzet be van jelölve, akkor a webhook hiba esetén a megadott URL-címre történő küldéskor a webhook újra meg fogja próbálni a küldést (Ajánlott ezt a funkciót engedélyezve tartani). További részletekért lásd a "Webhook mechanizmus újraküldése" című részt.
4. Válassza ki a módszert - GET vagy POST típusú kérés:
   • GET - a kérés adatokat kér egy adott erőforrástól (webhelytől);
   • POST - a kérés adatokat küld a kiszolgálónak további feldolgozásra.
5. Válassza ki az adattípust - JSON vagy Textadattípusok:
   • JSON - JSON formátumú adatszerkezet;
   • Text - szabad kitöltés. Tetszés szerint és az igényeinek megfelelően bármilyen formátumban és struktúrában kitöltheti.

6.  Elérhető paraméterek - az eseménytípustól függő paraméterek. A rendelkezésre álló paraméterek a webhook-beállítások bármely pontján hozzáadhatók, egyszerűen rákattintva.

7. Felhasználói paraméterek - további paraméterek, amelyek a JSON-struktúrához adódnak hozzá a fenti kék jelölőnégyzetekkel jelölt változókon kívül.

8. Lekérdezési paraméterek - az URL-lekérdezési paraméterek (URL Query Parameters) az URL-hez hozzáadható további információk. Két kötelező elemből áll - magából a paraméterből és annak értékéből, amelyeket egyenlőségjel(=) választ el.

• Például: https://site.com/?first_parametr=first_value&second_parametr=second_value

9. HTTP fejlécek (HTTP Headers) - néhány sornyi, meghatározott formátumú szöveg, amely vagy a kérést pontosítja, vagy az üzenettörzs tartalmát írja le.

For more details on request types see:

"POST request"

"GET request"