사용 안내서 취소

새 Webhook 구성

 

Adobe Acrobat Sign 안내서

새로운 기능

시작하기

관리

계약 전송, 서명 및 관리

고급 계약 기능 및 워크플로우

다른 제품과 통합

Acrobat Sign 개발자

지원 및 문제 해결

구성 옵션

Webhook을 구성하려면 5개 요소를 정의해야 합니다.

  • 이름 - 관리자가 쉽게 이해할 수 있는 직관적인 이름이 권장됩니다.
  • 범위 - Webhook의 도달 범위입니다. 인터페이스에서 계정 및 그룹을 사용할 수 있습니다.
    • API에서는 계정, 그룹, 사용자 및 리소스 범위를 지원합니다.
    • Webhook당 하나의 범위만 정의할 수 있습니다.
  • URL - Adobe Sign이 JSON 페이로드를 푸시한 대상 URL입니다.
  • 이벤트 - Adobe Sign이 JSON을 빌드하고 URL로 푸시하도록 하는 트리거입니다.
    • 각 이벤트는 트리거 이벤트와 관련된 다른 페이로드를 빌드합니다.
    • 하나의 Webhook에 여러 이벤트가 포함될 수 있습니다.
  • 알림 매개변수 - 알림 매개변수이벤트 JSON 페이로드의 섹션을 식별하므로 이 Webhook에 중요한 이벤트 섹션만 선택할 수 있으며, 따라서 URL로 전송하는 불필요한 데이터가 감소됩니다.

Webhook이 완벽히 정의된 후 저장을 클릭하면 새 Webhook이 반응하여 즉시 이벤트를 트리거합니다.

참고:

위에 설명된 확인 프로토콜에 따라 Webhook 확인 및 Webhook 알림 요청에 응답하도록 Webhook URL을 구성하세요. Acrobat Sign 웹 애플리케이션에서 생성된 Webhook으로 전송되는 클라이언트 ID(애플리케이션 ID)는 UB7E5BXCXY입니다.

Webhook 구성

범위

  • 계정: 계정에서 발생하는 모든 구독 이벤트는 푸시를 트리거합니다.
    • 계정 관리자는 계정 및 해당 계정 내의 모든 그룹에 대해 정의된 모든 Webhook을 볼 권한이 있습니다.
  • 그룹: 그룹에서 발생하는 모든 구독 이벤트는 푸시를 트리거합니다. 참고: 그룹 범위 Webhook은 하나의 해당 그룹에 대해서만 존재합니다.
    • 그룹 관리자는 해당 그룹 전용 Webhook만 볼 수 있습니다. 계정 수준 Webhook 또는 다른 그룹에 바인딩된 Webhook은 볼 수 없습니다.
    • 다중 그룹의 사용자가 활성화된 계정에는 범위를 적용해야 하는 그룹을 설정하는 옵션이 표시됩니다.
  • 사용자 계정: 사용자 계정에 대한 모든 구독 이벤트는 푸시를 트리거합니다. 사용자 수준 Webhook은 API를 통해서만 만들 수 있습니다.
  • 리소스 수준 Webhook: 특정 리소스에 대해 생성됩니다. 이 리소스와 관련된 이벤트는 Webhook URL로 푸시됩니다. 리소스 수준 Webhook은 API를 통해서만 만들 수 있습니다.

URL

Webhook URL은 이벤트가 발생할 때 트리거되는 수신 HTTPS POST 알림 메시지를 수신 대기하는 서버입니다.

Webhook에서 이벤트를 구독하려면 이 URL이 필요합니다.

  • 클라이언트에는 Acrobat Sign이 POST할 수 있는 HTTPS URL이 포함되어야 합니다. 이 URL은 공용 인터넷에서 사용할 수 있어야 합니다.  
    • 예를 들어 127.0.0.1 및 localhost URI는 작동하지 않습니다.
    • URL 엔드포인트는 포트 443 또는 8443에서 수신 대기해야 합니다(콜백 URL을 정의할 때 고객이 결정).
  • Webhook에서 수신 이벤트 알림에 대한 POST 요청과 확인 요청에 대한 GET 요청을 지원하는지 확인합니다.
  • URL은 방화벽으로 차단해서는 안 됩니다.

이벤트

다음은 Webhook URL로 푸시를 트리거할 수 있는 이벤트로서, 개체별로 그룹화되고 UI에 있는 순서대로 나열됩니다.

왼쪽 값은 Acrobat Sign UI에 표시되는 값입니다. 오른쪽 값은 API에서 Webhook 이름입니다.

Webhook 및 해당 페이로드에 대한 자세한 내용은 Acrobat Sign 개발자 안내서를 참조하세요.

계약:

UI 요소 Webhook 이름
계약 모든 이벤트 AGREEMENT_ALL
계약이 생성됨 AGREEMENT_CREATED
계약서 전송됨 AGREEMENT_ACTION_REQUESTED
계약 참가자가 완료함 AGREEMENT_ACTION_COMPLETED
계약 워크플로우가 완료됨 AGREEMENT_WORKFLOW_COMPLETED
계약이 만료됨 AGREEMENT_EXPIRED
계약이 삭제됨 AGREEMENT_DOCUMENTS_DELETED
계약이 취소됨 AGREEMENT_RECALLED
계약이 거부됨 AGREEMENT_REJECTED
계약이 공유됨 AGREEMENT_SHARED
계약이 공유되지 않았습니다 AGREEMENT_UNSHARE
계약 공유 안 됨 자동 AGREEMENT_UNSHARE_AUTO
계약이 위임됨 AGREEMENT_ACTION_DELEGATED
계약 참가자가 교체됨 AGREEMENT_ACTION_REPLACED_SIGNER
계약이 수정됨 AGREEMENT_MODIFIED
계약 수정이 승인됨 AGREEMENT_USER_ACK_AGREEMENT_MODIFIED
계약 이메일을 봄 AGREEMENT_EMAIL_VIEWED
계약 이메일이 반송됨 AGREEMENT_EMAIL_BOUNCED
계약 문서를 봄 AGREEMENT_DOCUMENTS_VIEWED
문서 보기에 암호가 적용되었을 때 본 계약 문서 AGREEMENT_DOCUMENTS_VIEWED_PASSWORD_PROTECTED
계약 작성 실패 AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
계약이 동기화된 사후 오프라인 이벤트 AGREEMENT_OFFLINE_SYNC
계약이 보관됨 AGREEMENT_VAULTED
계약 참가자 소셜 신원이 인증됨 AGREEMENT_WEB_IDENTITY_AUTHENTICATED
계약 참가자 KBA가 인증됨 AGREEMENT_KBA_AUTHENTICATED
계약 참가자 이메일 OTP가 인증됨
AGREEMENT_EMAIL_OTP_AUTHENTICATED
계약 만료 업데이트됨 AGREEMENT_EXPIRATION_UPDATED
계약 알림 전송됨 AGREEMENT_REMINDER_SENT
서명자가 계약 서명자 이름을 변경함 AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER
계약 미리 알림 시작됨 AGREEMENT_REMINDER_INITIATED
   
계약 Webhook은 API를 통해서만 사용 가능
UI 요소 Webhook 이름
NA
AGREEMENT_READY_TO_NOTARIZE
NA
AGREEMENT_READY_TO_VAULT

 

대량 전송:

UI 요소 Webhook 이름
모든 이벤트 대량 전송 MEGASIGN_ALL
대량 전송 생성됨
MEGASIGN_CREATED
대량 전송 공유됨
MEGASIGN_SHARED
대량 전송 회수됨
MEGASIGN_RECALLED
대량 알림 메시지로 전송됨 MEGASIGN_REMINDER_SENT
대량 전송 미리 알림 시작됨 MEGASIGN_REMINDER_INITIATED

 

웹 양식:

UI 요소 Webhook 이름
웹 양식 모든 이벤트 WIDGET_ALL
웹 양식이 생성됨
WIDGET_CREATED
웹 양식이 활성화됨
WIDGET_ENABLED
웹 양식이 비활성화됨
WIDGET_DISABLED
웹 양식이 수정됨
WIDGET_MODIFIED
웹 양식이 공유됨
WIDGET_SHARED
웹 양식 생성 실패
WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM

 

라이브러리 템플릿(API만 해당):

UI 요소 Webhook 이름
NA LIBRARY_DOCUMENT_ALL
NA LIBRARY_DOCUMENT_CREATED
NA LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
NA LIBRARY_DOCUMENT_MODIFIED

 

알림 매개변수

알림 매개변수를 사용하면 JSON 페이로드를 이벤트의 특정 요소에만 맞게 사용자 지정할 수 있습니다.

예를 들어, 계약 참가자 교체 이벤트에서 문서 정보는 생략하고 Webhook URL로 전송되는 JSON의 전체 크기를 줄이고 계약 정보참가자 정보만 원할 수 있습니다.

 

  • 계약
    • 계약 정보 - 트리거 이벤트 발생 시의 계약 상태를 기반으로 하는 자세한 계약 정보입니다.
    • 계약 문서 정보 - 이벤트의 결과로 생성된 모든 문서 정보를 포함합니다.
    • 계약 참가자 정보 - 이벤트의 결과로 모든 참가자 정보를 포함합니다.
    • 서명된 계약 문서 - 서명된 PDF를 제공합니다. 
      • 계약 워크플로우 완료모두 계약 이벤트에 적용됩니다.
  • 대량 전송
    • 대량 전송 정보 - 이벤트를 트리거한 대량 전송 개체에 대한 자세한 정보입니다.
  • 웹 양식
    • 위젯 정보 - 이벤트를 트리거한 웹 양식에 대한 자세한 정보입니다.
    • 위젯 문서 정보 - 웹 양식과 연결된 문서 정보입니다.
    • 위젯 참가자 정보 - 웹 양식에 정의된 참가자에 대한 정보입니다.

쉽고 빠르게 지원 받기

신규 사용자이신가요?