Podręcznik użytkownika Anuluj

Konfiguracja nowego elementu webhook

 

Podręcznik Adobe Acrobat Sign

Nowości

Pierwsze kroki

Administrowanie

Wysyłanie i podpisywanie umów oraz zarządzanie nimi

Zaawansowane możliwości umów i obiegów pracy

Integracja z innymi produktami

Programista Acrobat Sign

Pomoc techniczna i rozwiązywanie problemów

Opcje konfiguracji

Konfiguracja elementów Webhook wymaga zdefiniowania pięciu elementów:

  • Nazwa — jest intuicyjną nazwą, którą inni administratorzy mogą łatwo zrozumieć.
  • Zakres — jak szeroka jest sieć do przechwytywania elementów webhook? Konto i grupa są dostępne w interfejsie.
    • Interfejs API obsługuje zakresy Konto, Grupa, Użytkownik i Zasoby.
    • Można zdefiniować tylko jeden zakres na element webhook.
  • URL — docelowy adres URL, do którego usługa Acrobat Sign wypchnęła ładunek JSON.
  • Zdarzenia — wyzwalacz, który powoduje, że usługa Acrobat Sign tworzy JSON i wypycha na adres URL.
    • Każde zdarzenie tworzy inny ładunek, odpowiedni do zdarzenia wyzwalającego.
    • W jednym elemencie webhook można zawrzeć wiele zdarzeń.
  • Parametry powiadomień — parametry powiadomień identyfikują sekcje Zdarzenia ładunku JSON, pozwalając wybrać tylko te sekcje Zdarzenia, które są ważne dla tego elementu webhook (a tym samym zmniejszając ilość niepotrzebnych danych wysyłanych na adres URL).

Po zdefiniowaniu elementu webhook kliknij przycisk Zapisz, a nowy element webhook zacznie reagować natychmiast na zdarzenia wyzwalacza.

Uwaga:

Skonfiguruj swój adres URL elementu webhook tak, aby odpowiadał na żądania weryfikacji webhook i powiadomienia webhook zgodnie z protokołem weryfikacji opisanym powyżej. Identyfikator klienta (identyfikator aplikacji), który zostanie wysłany do elementów webhook utworzonych z aplikacji internetowej Acrobat Sign, będzie miał postać — UB7E5BXCXY

Skonfiguruj element webhook

Zakresy

  • Konto: wszystkie subskrybowane zdarzenia występujące na koncie powodują uruchomienie mechanizmu push.
    • Administratorzy kont mają uprawnienia do przeglądania wszystkich elementów webhook zdefiniowanych dla danego konta i grup w ramach tego konta.
  • Grupa: wszystkie subskrybowane zdarzenia występujące w tej grupie powodują uruchomienie mechanizmu push. UWAGA: elementy webhook w zakresie grupy istnieją tylko dla tej grupy.
    • Administratorzy grup będą widzieć tylko te elementy webhook, które są przypisane do ich grupy. Nie widzą oni elementów webhook poziomu konta ani elementów webhook przypisanych do innych grup.
    • Konta z włączoną opcją Użytkownicy w wielu grupach będą widzieć opcję ustawienia Grupy, w której Zakres ma zostać zastosowany.
  • Konto użytkownika: wszystkie subskrybowane zdarzenia dla konta użytkownika powodują uruchomienie mechanizmu push. Elementy webhook na poziomie użytkownika można tworzyć wyłącznie za pośrednictwem interfejsu API.
  • Element webhook na poziomie zasobu: zostanie on utworzony dla konkretnego zasobu. Zdarzenia specyficzne dla tego zasobu będą przesyłane do adresu URL elementu webhook. Elementy webhook na poziomie zasobu można tworzyć wyłącznie za pośrednictwem interfejsu API.

URL

Adres URL elementu webhook to serwer nasłuchujący przychodzących komunikatów powiadamiających HTTPS POST, które są uruchamiane w momencie wystąpienia zdarzeń.

Ten adres URL jest potrzebny do subskrybowania zdarzeń za pomocą elementów webhook.

  • Klient musi zawierać adres URL HTTPS, do którego program Acrobat Sign może wysłać POST. Ten adres URL musi być dostępny w publicznym Internecie.  
    • Na przykład adresy URI 127.0.0.1 i localhost nie będą działać.
    • Punkt końcowy adresu URL musi nasłuchiwać na porcie 443 lub 8443 (określonym przez klienta podczas definiowania adresu URL wywołania zwrotnego).
  • Upewnij się, że element webhook obsługuje żądania POST dla przychodzących powiadomień o zdarzeniach oraz żądania GET dla żądania weryfikacji.
  • Adres URL nie powinien być blokowany przez zaporę sieciową.

Zdarzenia

Poniżej znajdują się zdarzenia, które mogą wyzwolić wysyłanie na adres URL elementu webhook, pogrupowane według obiektów i wymienione w kolejności znalezionej w interfejsie użytkownika.

Wartość po lewej stronie to wartość widoczna w interfejsie użytkownika usługi Acrobat Sign. Wartość po prawej stronie to nazwa elementu webhook w interfejsie API.

Aby uzyskać szczegółowe informacje dotyczące elementów webhook i ich ładunków, zobacz Podręcznik dla programistów aplikacji Acrobat Sign.

Umowy:

Element interfejsu użytkownika Nazwa elementu webhook
Wszystkie wydarzenia umowy AGREEMENT_ALL
Utworzono umowę AGREEMENT_CREATED
Umowa została wysłana AGREEMENT_ACTION_REQUESTED
Zakończono pracę dotyczącą uczestnika umowy AGREEMENT_ACTION_COMPLETED
Zakończono obieg pracy umowy AGREEMENT_WORKFLOW_COMPLETED
Umowa wygasła AGREEMENT_EXPIRED
Usunięto umowę AGREEMENT_DOCUMENTS_DELETED
Umowa anulowana AGREEMENT_RECALLED
Odrzucono umowę AGREEMENT_REJECTED
Umowa udostępniona AGREEMENT_SHARED
Anulowano udostępnienie umowy AGREEMENT_UNSHARE
Automatycznie anulowano udostępnienie umowy AGREEMENT_UNSHARE_AUTO
Umowa została oddelegowana AGREEMENT_ACTION_DELEGATED
Zastąpiono uczestnika umowy AGREEMENT_ACTION_REPLACED_SIGNER
Zmodyfikowano umowę AGREEMENT_MODIFIED
Uznano modyfikację umowy AGREEMENT_USER_ACK_AGREEMENT_MODIFIED
Wiadomość e-mail dotycząca umowy wyświetlona AGREEMENT_EMAIL_VIEWED
Wiadomość e-mail dotycząca umowy została zwrócona AGREEMENT_EMAIL_BOUNCED
Wyświetlane dokumenty umowy AGREEMENT_DOCUMENTS_VIEWED
Wyświetlany dokument umowy po zastosowaniu hasła do wyświetlenia dokumentu AGREEMENT_DOCUMENTS_VIEWED_PASSWORD_PROTECTED
Nie udało się utworzyć umowy AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
Umowa zsynchronizowana po zdarzeniu offline AGREEMENT_OFFLINE_SYNC
Umowa zarchiwizowana AGREEMENT_VAULTED
Uczestnik umowy został uwierzytelniony za pomocą tożsamości społecznościowej AGREEMENT_WEB_IDENTITY_AUTHENTICATED
Uczestnik umowy został uwierzytelniony za pomocą KBA AGREEMENT_KBA_AUTHENTICATED
Uczestnik umowy uwierzytelniony za pomocą wiadomość e-mail z jednorazowym hasłem (OTP)
AGREEMENT_EMAIL_OTP_AUTHENTICATED
Data wygaśnięcia umowy została uaktualniona AGREEMENT_EXPIRATION_UPDATED
Wysłano przypomnienie o umowie AGREEMENT_REMINDER_SENT
Nazwa sygnatariusza umowy została zmieniona przez sygnatariusza AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER
Zainicjowano przypomnienie o umowie AGREEMENT_REMINDER_INITIATED
   
Elementy webhook umowy dostępne tylko za pośrednictwem interfejsu API
Element interfejsu użytkownika Nazwa elementu webhook
nd.
AGREEMENT_READY_TO_NOTARIZE
nd.
AGREEMENT_READY_TO_VAULT

 

Wyślij zbiorczo:

Element interfejsu użytkownika Nazwa elementu webhook
Wyślij zbiorczo – wszystkie zdarzenia MEGASIGN_ALL
Wyślij zbiorczo – utworzone
MEGASIGN_CREATED
Wyślij zbiorczo – udostępnione
MEGASIGN_SHARED
Wyślij zbiorczo – przywołane
MEGASIGN_RECALLED
Wysłano przypomnienie o wysyłce zbiorczej MEGASIGN_REMINDER_SENT
Zainicjowano przypomnienie o wysyłce zbiorczej MEGASIGN_REMINDER_INITIATED

 

Formularze internetowe:

Element interfejsu użytkownika Nazwa elementu webhook
Formularz internetowy — wszystkie wydarzenia WIDGET_ALL
Utworzono formularz internetowy
WIDGET_CREATED
Włączono formularz internetowy
WIDGET_ENABLED
Wyłączono formularz internetowy
WIDGET_DISABLED
Zmodyfikowano formularz internetowy
WIDGET_MODIFIED
Udostępniono formularz internetowy
WIDGET_SHARED
Nie udało się utworzyć formularza internetowego
WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM

 

Szablony biblioteki (tylko API):

Element interfejsu użytkownika Nazwa elementu webhook
n.d. LIBRARY_DOCUMENT_ALL
n.d. LIBRARY_DOCUMENT_CREATED
n.d. LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
n.d. LIBRARY_DOCUMENT_MODIFIED

 

Parametry powiadomień

Parametry powiadomień umożliwiają dostosowanie zawartości pliku JSON do określonych elementów zdarzenia.

Na przykład w przypadku zdarzenia Zastąpiono uczestnika umowy możesz chcieć tylko Informacje o umowie i Informacje o użytkowniku, pomijając Informacje o dokumencie i zmniejszając całkowitą objętość pliku JSON wysłanego na adres URL elementu webhook.

 

  • Umowa
    • Informacje o umowie — szczegółowe informacje o umowie na podstawie statusu umowy w momencie wystąpienia zdarzenia wyzwalającego.
    • Informacje o dokumencie umowy — zawiera wszelkie informacje o dokumentach wygenerowane w wyniku zdarzenia.
    • Informacje o uczestniku umowy — zawiera wszelkie informacje o uczestniku wynikające ze zdarzenia.
    • Dokument podpisany w ramach umowy — udostępnia podpisany plik PDF.
      • Dotyczy Obieg umowy zakończono pomyślnie Wszystkie wydarzenia umowy.
  • Wyślij zbiorczo
    • Informacje o funkcji Wyślij zbiorczo — szczegółowe informacje o obiekcie wysyłania zbiorczego, który wywołał zdarzenie.
  • Formularz internetowy
    • Informacje o widżecie — szczegółowe informacje o formularzu internetowym, który wywołał zdarzenie.
    • Informacje o dokumentach widżetu — informacje o dokumencie związane z formularzem internetowym.
    • Informacje o uczestnikach widżetu — informacje o zdefiniowanych uczestnikach w formularzu internetowym.

Pomoc dostępna szybciej i łatwiej

Nowy użytkownik?