Webhook event
Webhook Events
Webhook을 사용하면 문서의 주요 상태 변화를 이벤트로 전달받아 내부 시스템에 반영하거나 후속 작업을 자동화할 수 있습니다.
-
문서의 서명 / 열람 진행 상태 동기화
-
문서 상태 변화에 따른 내부 알림이나 후속 작업 실행
이벤트별 발생 조건과 예제
새로운 문서로 서명/열람 요청이 시작됨
document_started{
"event": {
"type": "document_started"
},
"document": {
"id": "{DOCUMENT_ID}",
"requester": {
"email": "{REQUESTER_EMAIL}"
}
}
}문서의 모든 참여자가 서명 또는 열람을 완료함
document_all_signed{
"event": {
"type": "document_all_signed"
},
"document": {
"id": "{DOCUMENT_ID}",
"requester": {
"email": "{REQUESTER_EMAIL}"
}
}
}참여자가 서명 요청을 거절함
document_rejected{
"event": {
"type": "document_rejected"
},
"document": {
"id": "{DOCUMENT_ID}",
"requester": {
"email": "{REQUESTER_EMAIL}"
}
}
}문서의 서명 요청이 취소됨
document_request_canceled{
"event": {
"type": "document_request_canceled"
},
"document": {
"id": "{DOCUMENT_ID}",
"requester": {
"email": "{REQUESTER_EMAIL}"
}
}
}참여자가 입력한 서명을 취소함
document_signing_canceled{
"event": {
"type": "document_signing_canceled"
},
"document": {
"id": "{DOCUMENT_ID}",
"requester": {
"email": "{REQUESTER_EMAIL}"
}
}
}요청자가 내용 수정을 시작함
document_modification_started{
"event": {
"type": "document_modification_started"
},
"document": {
"id": "{DOCUMENT_ID}",
"requester": {
"email": "{REQUESTER_EMAIL}"
}
}
}내용 수정 완료됨
document_modification_completed{
"event": {
"type": "document_modification_completed"
},
"document": {
"id": "{DOCUMENT_ID}",
"requester": {
"email": "{REQUESTER_EMAIL}"
}
}
}내부결재로 요청된 문서 수정 완료 후 내부결재 재요청됨
document_modification_approval_requested{
"event": {
"type": "document_modification_approval_requested"
},
"document": {
"id": "{DOCUMENT_ID}",
"requester": {
"email": "{REQUESTER_EMAIL}"
}
}
}내용 수정 취소됨
document_modification_canceled{
"event": {
"type": "document_modification_canceled"
},
"document": {
"id": "{DOCUMENT_ID}",
"requester": {
"email": "{REQUESTER_EMAIL}"
}
}
}Webhook 처리 권장사항
권장 구현 방식
- 2xx 응답을 먼저 반환한 뒤 내부 작업을 수행합니다.
- 동일한 이벤트가 여러 번 전달되어도 문제가 없도록 멱등하게 처리합니다.
document.id를 내부 시스템의 문서 식별자와 연결합니다.- 필요한 최신 정보는 문서 상세 조회 API로 다시 조회합니다.
실패 및 재시도 정책
Webhook 요청에 대한 응답 상태와 처리 정책은 다음과 같습니다.
| 조건 | 실패 처리 | 재시도 |
|---|---|---|
| 2xx 응답 | 아니요 | 아니요 |
| 일반적인 2xx 외 응답 | 예 | 최대 5회 |
| 401, 404 응답 | 예 | 하지 않음 |
| 10초 timeout | 예 | 하지 않음 |
Updated 20 days ago
Did this page help you?