웹훅 이용하기

프릭스에서 제공하는 웹훅 이벤트 목록입니다. 웹훅 연동 방법은 프릭스 담당자에게 문의해 주세요.

(1) 웹훅 이벤트 타입

웹훅으로 등록할 수 있는 이벤트 타입은 아래와 같습니다.

이벤트 타입	설명	카테고리
CONTRACT_CREATED	계약서 등록 이벤트입니다.	계약서
SIGNATURE_CREATED	전자서명 생성 이벤트입니다.	전자서명
SIGNATURE_CONCLUDED	모든 참여자가 서명을 완료하여 계약이 체결되는 이벤트입니다.	전자서명
SIGNATURE_PARTICIPATED	개별 전자서명 참여자의 서명 완료 이벤트입니다.	전자서명
SIGNATURE_EXPIRED	전자서명이 체결되지 않고 만료된 경우, 만료일 다음날 오전 11시에 호출되는 전자서명 만료 이벤트입니다.	전자서명
DOCUMENT_CREATED	영업문서 생성 완료 이벤트입니다.	영업문서

(2) 계약서 카테고리 웹훅 이벤트 본문

계약서 카테고리의 웹훅 요청의 Body 예시입니다.

{
  "eventType": "CONTRACT_CREATED",
  "createdAt": "2024-11-15T00:00:00.000Z",
  "contract": {
    "uuid": "ed976505-bcbd-47bd-913d-f4cde05dea7a", // 문서 식별값 (uuid 값을 api에서 사용)
    "title": "A컴퍼니 MOU", // 계약서 이름
    "status": "CREATED", // 계약 상태 (CREATED, CONCLUDED)
    "createdAt": "2024-11-15T00:00:00.000Z"
  }
}

(3) 전자서명 카테고리 웹훅 이벤트 본문

전자서명 카테고리의 웹훅 요청의 Body 예시입니다.

{
  "eventType": "SIGNATURE_CREATED",
  "createdAt": "2024-11-15T00:00:00.000Z",
  "contract": {
    "uuid": "ed976505-bcbd-47bd-913d-f4cde05dea7a", // 문서 식별값 (uuid 값을 api에서 사용)
    "title": "A컴퍼니 MOU", // 계약서 이름
    "status": "CREATED", // 계약 상태 (CREATED, CONCLUDED)
    "createdAt": "2024-11-01T00:00:00.000Z"
  },
  "signature": {
    "uuid": "57139f5c-37d0-4c30-bdb6-ef6106040756", // 전자서명 식별자
    "title": "A컴퍼니 MOU 서명 요청", // 전자서명 이름
    "status": "WAITING", // 상태 (WAITING, DONE, CANCELED / WAITING은 서명 요청 후 대기 상태를 의미)
    "createdAt": "2024-11-15T00:00:00.000Z"
  }
}

(4) 영업문서 카테고리 웹훅 이벤트 본문

영업문서 카테고리의 웹훅 요청의 Body 예시입니다.

{
  "eventType": "DOCUMENT_CREATED",
  "createdAt": "2024-11-15T00:00:00.000Z",
  "document": {
    "id": 1,
    "uuid": "ed976505-bcbd-47bd-913d-f4cde05dea7a", // 문서 식별값 (uuid 값을 api에서 사용)
    "title": "A컴퍼니 영업문서", // 영업문서 이름
    "status": "CREATED", // 영업문서 상태 (CREATED, SENT, APPROVED, DELETED)
    "createdAt": "2024-11-01T00:00:00.000Z",
    "updatedAt": "2024-11-01T00:00:00.000Z"
  }
}