DocsReferencesChangelog
Docs

Webhook event

워크스페이스가 소유하고 있는 문서에 대해 웹훅이 발생되는 이벤트는 아래와 같습니다.

📘

아래와 같은 상황에서 Webhook은 호출 실패로 판단하고 최대 5회 재시도 합니다.

Webhook event 수신 시 200번대 응답이 아닐 경우 재시도합니다.
응답을(200번대 응답) 먼저 회신 후 내부 작업을 진행해주시는 것을 권장 드립니다.

📌 다음의 경우 Webhook 요청 실패로 간주합니다.

  • 2xx 응답이 아닌경우
  • 응답에 10초 이상 소요되는 경우(timeout)

📌 요청 실패로 간주된 경우, 실패 처리 정책에 따라, Webhook 최대 5회 요청이 될 수 있습니다.

❗️정상 처리가 되었음에도 2xx로 응답하지 않는 경우, Webhook이 재전송되며 중복으로 처리 될 수 있습니다.
이점 양지하셔서 올바른 응답을 회신한 후 다음 작업을 수행하도록 구현하시는 것을 권장해 드립니다.

📌 아래의 경우는 재시도 했을 때 성공 전활율이 낮거나, 의도하지 않은 중복 작업을 발생시킬 가능성 있으므로 재시도 하지 않습니다.

  • 401, 404 응답을 반환환 경우
  • 응답에 10초 이상이 소요되는 경우(timeout)

Webhook POST 요청의 json body 구조

서명 요청

새로운 문서로 서명 요청이 시작됨

document_started

{
  "event": {
    "type": "document_started"
  },
  "document": {
    "id": "{DOCUMENT_ID}",
    "requester": {
      "email": "{REQUESTER_EMAIL}"
    }
  }
}

 

 

서명 입력

참여자가 문서에 서명을 입력함

document_signed

{
  "event": {
    "type": "document_signed"
  },
  "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}"
    }
  }
}

Updated 10 months ago