Skip to main content
A végpontalapú webhookrendszerrel szervezetenként több célhelyet is regisztrálhat, amelyek mindegyike saját titkos kulccsal, állapottal és az eseménytípusok egy részhalmazára vonatkozó saját előfizetéssel rendelkezik. Ez az ajánlott modell minden új integrációhoz. Hasonlítsa össze a régi, egyetlen URL-es webhookkal, amelyet a visszamenőleges kompatibilitás érdekében tartunk fenn, de szervezetenként csak egy URL-t támogat.

Végpontok

Végpontobjektum

A végpont teljes secret értéke létrehozáskor egyszer jelenik meg, ezt követően soha többé. Tárolja biztonságosan — ha elveszíti, törölje a végpontot, majd hozza létre újra.

Érvényes eseménytípusok

Az events mezőt pontosan ezzel a készlettel validáljuk — a listán kívüli értékek 400 választ adnak vissza. Az egyes típusok payloadstruktúráját lásd az Eseménykatalógusban.
  • telephony.incoming, telephony.complete, telephony.tool
  • web.incoming, web.complete, web.tool
  • call.graded
  • issue.reported
  • test-call.completed
  • alert.triggered

Végpontállapotok

  • active — a kézbesítések normálisan zajlanak.
  • disabled — manuálisan szüneteltetve PATCH segítségével. Nem küldünk kéréseket. Soha nem módosítjuk a disabled végpont állapotát; az active állapotra való visszaállítás mindig az Ön döntése.
  • failing — automatikusan beállítva, ha egy végpontra irányuló kézbesítés a teljes újrapróbálkozási ütemezését (8 kísérlet 24 óra alatt) kimeríti anélkül, hogy valaha is 2xx választ kapna. A hibás végpont nem kap további forgalmat. Miután kijavította a végpontot, PATCH segítségével állítsa vissza az állapotát active értékre; azok a kézbesítések, amelyeknek az újrapróbálkozási ütemezése még nem járt le, ott folytatódnak, ahol abbahagyták.

Végpontok listázása

Végpontobjektumok tömbjét adja vissza.

Webhook-végpont létrehozása

Kérelemmezők

201 Created választ ad vissza a végpontobjektummal, valamint egy további felső szintű secret mezővel, amely a nyers aláírókulcsot tartalmazza — egy 48 karakteres hexadecimális karakterláncot:
A secret csak létrehozáskor kerül visszaadásra. A későbbi GET válaszok csak a secret_hint értéket tartalmazzák. A válasz elvetése előtt másolja a teljes értéket a titokkezelőjébe.

Webhook-végpont frissítése

200 OK választ ad vissza a frissített végpontobjektummal.

Tesztkézbesítés küldése

Küldjön szintetikus webhook.test eseményt egy végpontra a normál kézbesítési folyamat használatával, beleértve a kanonikus JSON-szerializálást, az X-ThunderPhone-Signature fejlécet, a kézbesítés rögzítését és az újrapróbálkozások nyilvántartását. A teszt a kiválasztott végpontot célozza annak events szűrőjétől függetlenül.
A végpont az alábbihoz hasonló burkolót kap:
Az API az első kísérlet után 200 OK választ ad vissza, akkor is, ha a célhely hibát küld vissza. A kézbesítés eredményét a success, status, response_code és error mezőkben ellenőrizheti:
A webhook.test szintetikus, és nem adható hozzá egy végpont events feliratkozásához. Ha az első kísérlet sikertelen, a kézbesítés ugyanazt az újrapróbálkozási ütemezést követi, mint a normál eseménykézbesítések.

Végpont törlése

204 No Content választ ad vissza. Az URL-re történő kézbesítés azonnal leáll; a folyamatban lévő újrapróbálkozások megszakadnak.

Kapcsolódó témák

Eseménykatalógus

Az előfizethető events értékek teljes listája.

Webhookok áttekintése

Aláírás-ellenőrzés és kézbesítési szemantika.