Webhooki: zdarzenia dokumentów w Twoim systemie
Webhook wysyła podpisany JSON na Twój URL, gdy dokument zostanie wysłany, otwarty, podpisany, ukończony, odrzucony lub anulowany albo wygaśnie. Wymaga Pro; ustawia go właściciel lub administrator.
To tłumaczenie jest starsze niż artykuł po angielsku, więc niektóre szczegóły mogły się zmienić. Przeczytaj wersję angielską
Na tej stronie
Webhook wysyła wiadomość na Twój adres URL za każdym razem, gdy coś dzieje się z dokumentem, aby Twój system mógł na to zareagować. Webhooki są częścią planu Pro: działają w przestrzeni roboczej, dopóki jeden z jej właścicieli ma Pro, a zarządzać nimi mogą tylko właściciele i administratorzy. Każda przestrzeń robocza ma własne.
Dodaj webhook
- Otwórz Ustawienia i branding w menu konta i przejdź do sekcji Integracje.
- Naciśnij Dodaj webhook.
- Wpisz Adres URL endpointu. Musi zaczynać się od
https://i być publiczny: adresy w sieciach prywatnych, własne adresy Sealsimple i adresy URL z nazwą użytkownika i hasłem są odrzucane. - Jeśli chcesz, wpisz nazwę w polu Nazwa, wybierz Zdarzenia (na początku zaznaczone są wszystkie) i naciśnij Dodaj webhook.
- Skopiuj Klucz podpisujący, który się pojawi, i naciśnij Wyślij zdarzenie testowe.
Przestrzeń robocza może mieć do 10 webhooków.
Zdarzenia
document.sent: Dokument wysłanydocument.viewed: Otwarty przez odbiorcę, raz na odbiorcędocument.signed: Podpisany przez sygnatariusza, raz na sygnatariuszadocument.completed: Ukończony: wszyscy podpisalidocument.declined: Odrzuconydocument.expired: Wygasłydocument.canceled: Anulowany
Co wysyłamy
Żądanie POST z treścią JSON: id (takie samo przy każdej próbie, więc możesz pomijać duplikaty), event, created_at, workspace_id, obiekt document z polami id, title, status i url oraz, w przypadku zdarzeń dotyczących jednej osoby, obiekt recipient z polami name, email i role. Anulowany dokument ma status voided. Sam podpisany PDF nie jest wysyłany. Zdarzenie testowe ma zdarzenie test oraz zmyślony dokument i sygnatariusza.
Sprawdź podpis
Każde żądanie ma nagłówek Sealsimple-Signature w postaci t=1700000000,v1=…, obok nagłówków Sealsimple-Event i Sealsimple-Delivery. Aby go sprawdzić:
- Weź surową treść żądania, dokładnie w takiej postaci, w jakiej dotarła.
- Odczytaj z nagłówka
t(czas uniksowy w sekundach) iv1. - Oblicz HMAC-SHA256 z
t, kropki i treści, używając całego klucza podpisującego jako klucza, w zapisie szesnastkowym małymi literami. - Zaakceptuj żądanie tylko wtedy, gdy wynik jest równy
v1(porównuj w stałym czasie), atma najwyżej kilka minut.
W sekcji Jak połączyć pozycja Sprawdzanie podpisu (Node.js) pokazuje to jako kod, z przyciskiem Kopiuj kod. Nowy klucz od razu zastępuje klucz, więc zaraz potem zaktualizuj swoje sprawdzanie.
Ponowienia, dziennik i wstrzymywanie
Odpowiedz kodem statusu 2xx w ciągu 10 sekund. W przeciwnym razie spróbujemy ponownie później, łącznie do 6 prób w ciągu mniej więcej doby. Za przekierowaniami nie podążamy, a odpowiedź 410 kończy próby. Dziennik dostarczeń pokazuje ostatnie 50 wiadomości z odpowiedzią Twojego endpointu, a Wyślij ponownie wysyła wybraną jeszcze raz.
Po 20 nieudanych dostarczeniach z rzędu wstrzymujemy webhook (Wstrzymany po błędach) i wysyłamy e-mail do właścicieli przestrzeni roboczej. Napraw endpoint, ponownie włącz webhook i wyślij ponownie z dziennika to, czego potrzebujesz. Webhook możesz też wstrzymać jego przełącznikiem: zdarzenia, które nastąpią w czasie wstrzymania, nie zostaną wysłane później. Bez Pro webhooki zostają, ale niczego nie wysyłają.