Dokumentumesemények küldése a rendszerébe webhookkal

A webhook aláírt JSON-t küld az URL-jére, ha egy dokumentumot elküldenek, megnyitnak, aláírnak, befejeznek, elutasítanak, visszavonnak vagy lejár. Pro kell; tulajdonos vagy adminisztrátor állítja be.

Ez a fordítás régebbi az angol cikknél, ezért egyes részletek változhattak. Az angol változat elolvasása

A webhook minden alkalommal üzenetet küld egy Ön által megadott URL-re, amikor valami történik egy dokumentummal, így a saját rendszere reagálhat rá. A webhookok a Pro csomag részei: egy munkaterületen akkor működnek, ha egyik tulajdonosának Pro csomagja van, és csak a tulajdonosok és az adminisztrátorok kezelhetik őket. Minden munkaterületnek saját webhookjai vannak.

Webhook hozzáadása

  1. Nyissa meg a fiókmenüben a Beállítások és arculat oldalt, és lépjen az Integrációk részhez.
  2. Kattintson a Webhook hozzáadása gombra.
  3. Töltse ki a Végpont URL-címe mezőt. A címnek https:// előtaggal kell kezdődnie, és nyilvánosnak kell lennie: a magánhálózatokban lévő címeket, a Sealsimple saját címeit és a felhasználónevet és jelszót tartalmazó URL-eket elutasítjuk.
  4. Ha szeretné, adjon meg egy Név értéket, az Események résznél válassza ki a kívántakat (kezdetben mind be van jelölve), és kattintson a Webhook hozzáadása gombra.
  5. Másolja ki a megjelenő Aláírókulcs értékét, és kattintson a Tesztesemény küldése gombra.

Egy munkaterületen legfeljebb 10 webhook lehet.

Események

  • document.sent: Dokumentum elküldve
  • document.viewed: Egy címzett megnyitotta, címzettenként egyszer
  • document.signed: Egy aláíró aláírta, aláírónként egyszer
  • document.completed: Befejezve: mindenki aláírta
  • document.declined: Elutasítva
  • document.expired: Lejárt
  • document.canceled: Visszavonva

Mit küldünk?

Egy POST kérést JSON-törzzsel: id (minden próbálkozásnál ugyanaz, így kiszűrheti az ismétlődéseket), event, created_at, workspace_id, egy document az id, title, status és url mezővel, az egy személyt érintő eseményeknél pedig egy recipient a name, email és role mezővel. A visszavont dokumentum állapota voided. Magát az aláírt PDF-et nem küldjük el. A tesztesemény eseménye test, és egy kitalált dokumentumot és aláírót tartalmaz.

Az aláírás ellenőrzése

Minden kérés tartalmaz egy Sealsimple-Signature fejlécet, például t=1700000000,v1=…, a Sealsimple-Event és a Sealsimple-Delivery mellett. Az ellenőrzéshez:

  1. Vegye a nyers kéréstörzset, pontosan úgy, ahogy megérkezett.
  2. Olvassa ki a fejlécből a t (Unix-időbélyeg másodpercben) és a v1 értékét.
  3. Számítsa ki a t, egy pont és a törzs HMAC-SHA256 értékét, a teljes aláírókulccsal mint kulccsal, kisbetűs hexadecimális formában.
  4. Csak akkor fogadja el a kérést, ha ez megegyezik a v1 értékkel (konstans idejű összehasonlítással), és a t legfeljebb néhány perces.

Az Így csatlakoztathatja résznél Az aláírás ellenőrzése (Node.js) kódként mutatja ezt, egy Kód másolása gombbal. Az Új kulcs azonnal lecseréli a kulcsot, ezért utána rögtön frissítse az ellenőrzését.

Újrapróbálkozások, a napló és a szüneteltetés

Válaszoljon 10 másodpercen belül 2xx állapotkóddal. Különben később újrapróbálkozunk, összesen legfeljebb 6 alkalommal, nagyjából egy nap alatt. Az átirányításokat nem követjük, és egy 410 válasz leállítja a próbálkozásokat. A Kézbesítési napló a legutóbbi 50 üzenetet mutatja a végpontja válaszával, az Újraküldés pedig újra elküld egyet.

20 egymást követő sikertelen kézbesítés után szüneteltetjük a webhookot (Hibák miatt szüneteltetve), és e-mailt küldünk a munkaterület tulajdonosainak. Javítsa ki a végpontot, kapcsolja vissza a webhookot, és küldje el újra a naplóból, amire szüksége van. Egy webhookot a kapcsolójával is szüneteltethet: a szüneteltetés alatt történt eseményeket később sem küldjük el. Pro csomag nélkül a webhookok megmaradnak, de semmit sem küldenek.

Hasznos volt ez a cikk?

Próbálja ki a következő szerződésével.

Naptári hónaponként 5 ingyenes küldés. Nem kell bankkártya.

Még mindig segítségre van szüksége?

Kérdezze asszisztensünket a csevegésben: azonnal válaszol. Vagy írjon nekünk e-mailt, és egy munkatársunk egy munkanapon belül válaszol.