v1

latestOpenAPI 3.0.02026-07-2457351270.1 KB
USER API

웹훅 수정

요청한 정보를 통해 해당 웹훅의 정보를 수정 합니다.

put/webhooks/{webhookId}

Path parameters

webhookIdstring required

웹훅 아이디

Request body

namestring required

웹훅 명칭(사용자가 구분하기 쉽도록)

urlstring required

웹훅 이벤트를 전달받을 URL (POST Method 로 요청 됩니다)

eventsstring[]

활성화 하려는 웹훅 구독 이벤트 타입(속성 값이 전달되지 않거나 null인 경우 웹훅 구독 이벤트를 모두 제거 합니다.)

이벤트 종류:

  • document_started: 새로운 문서로 서명 요청이 시작됨
  • document_signed: 서명자가 문서에 서명을 입력함 (마지막 서명자의 서명 시에는 발행되지 않습니다.)
  • document_all_signed: 문서의 모든 서명자가 서명함 (마지막 서명자가 서명한 후 발행됩니다.)
  • document_rejected: 서명자가 문서에 서명을 거절함
  • document_request_canceled: 문서의 서명 요청이 취소됨
  • document_signing_canceled: 서명자가 입력한 서명을 취소함

Response

idstring required

웹훅 아이디

namestring required

사용자가 지정한 웹훅 이름

urlstring required

웹훅 URL

createdAtstring date-time required

웹훅 생성일

updatedAtstring date-time required

웹훅 갱신일

eventsstring[] required

웹훅 구독 이벤트 설정 정보