🥳 웹훅(Webhook) API 추가
API 로 웹훅 관리가 가능합니다!
웹훅을 통해 모두싸인에서 발생하는 이벤트를 사용자가 지정한 특정 URL로 POST 요청받을 수 있습니다.
이럴때 사용하세요!서명요청 시작부터 서명완료 과정에서 문서의 상태 변경 발생 시 고객사에서 운영중인 시스템의 특정 작업이 수행되어야 할 때(관리하고 있는 데이터의 상태 변경, 알림 전송 등), 모두싸인에서 발송하는 웹훅 이벤트를 받아 처리할 수 있습니다.
웹훅 기능에 대해 궁금하시면 Webhook 설정을 확인해 보세요
웹훅은 그동안 모두싸인 플랫폼 내에서 설정이 가능하며 많이 이용하고 계시는 기능 중 하나 입니다. API 로 제공되는 웹훅은 아래와 같은 상황에서 활용하기 더욱 좋습니다.
- 내부 정책상 모두싸인 플랫폼에 접속이 불가능 한 경우 웹훅 API 를 이용해 관리 프로그램을 직접 구현하여 이용 가능 합니다.
- OAuth 연동을 통해 관리하고 있는 고객사의 고객 워크스페이스에 웹훅을 등록하여, 해당 워크스페이스에서 요청한 문서 상태 변경에 대한 이벤트를 받아 활용할 수 있습니다.
아래와 같은 상황에서 Webhook은 호출 실패로 판단하고 재시도(총 5회)를 시도 하도록 합니다.200번대 응답이 아닐 경우
10초 이내에 응답이 오지 않을 경우Webhook event 수신 후 내부적으로 어떤 로직을 수행하는데 있어 10초 이상 지연 될 수 있다면, timeout 으로 인해 재전송 될 수 있으니, Webhook event 수신 시 응답을(200번대 응답) 먼저 회신 후 내부 작업을 진행해주시는 것을 권장 드립니다.
구독할 수 있는 웹훅 이벤트 종류는 아래와 같습니다.
- document_started (서명 요청)
- document_signed (서명 입력)
- document_all_signed (모든 서명 완료)
- document_rejected (거절)
- document_request_canceled (요청 취소)
- document_signing_canceled (서명 취소)
전달되는 이벤트 인터페이스 아래와 같습니다.
{
"event": {
"type": "{EVENT_TYPE}"
},
"document": {
"id": "{DOCUMENT_ID}",
"requester": {
"email": "{REQUESTER_EMAIL}"
}
}
}
