웹훅 형태

Payload

속성	유형	필수 여부	설명
event	string	Y	웹훅이 무엇에 대한 내용인지(= 구독 중인 웹훅 이벤트)를 나타냅니다 생성, 수정, 삭제, 병합 중 하나의 값을 가집니다.
occurredAt	string	Y	해당 이벤트가 언제 발생했는지를 나타냅니다. ISO 8601 형식으로 millisecond까지 표현된 ’YYYY-MM-DDThh:mm:ss.SSSZ’ 형식의 string 값입니다.
source	string	Y	해당 이벤트가 누구에 의해 발생한 이벤트인지를 나타냅니다. API, 시스템, 데이터 가져오기, 시퀀스, 웹 폼, 워크플로우, 사용자, 고객 중 하나의 값을 가집니다. API : api 요청에 의해 발생한 웹훅을 의미합니다. 시스템 : 시스템 연산에 의해 발생한 웹훅을 의미합니다. 데이터 가져오기 : 회사 설정> 데이터 가져오기를 한 결과 발생한 웹훅을 의미합니다. 시퀀스 : 시퀀스 등록에 의해 발생한 웹훅을 의미합니다. 웹 폼 : 웹 폼 제출로 발생한 웹훅을 의미합니다. 워크플로우 : 워크플로우에 의해 발생한 웹훅을 의미합니다. 사용자 : 사용자가 브라우저를 통해 한 행위에 의해 발생한 웹훅을 의미합니다. 고객 : 고객에 의해 발생한 웹훅을 의미합니다. (수신 거부 여부, 수신 거부 사유)
sourceId	string	N	해당 이벤트가 구체적으로 누구에 의해 발생한 이벤트인지를 나타냅니다. source가 API 이면 사용된 API 토큰의 “사용자 ID”를 의미합니다. source가 시스템이면 null 값을 가집니다. source가 데이터 가져오기면 데이터 가져오기에 사용된 “파일/스프레드시트 ID”를 의미합니다. source가 시퀀스면 “시퀀스 ID”를 의미합니다. source가 웹 폼이면 “웹 폼 ID”를 의미합니다. source가 워크플로우면 “워크플로우 ID”를 의미합니다. source가 사용자면 “사용자 ID”를 의미합니다. source가 고객이면 “고객 ID”를 의미합니다.
objectType	string	Y	해당 이벤트가 무엇을 나타내는 이벤트인지를 설명합니다. 딜, 리드, 고객, 회사 중 하나의 값을 가집니다.
objectId	string	Y	해당 이벤트가 구체적으로 무엇을 나타내는 이벤트인지를 설명합니다. objectType이 딜 이면 “딜 ID”를 의미합니다. objectType이 리드 면 “리드 ID”를 의미합니다. objectType이 고객 이면 “고객 ID”를 의미합니다. objectType이 회사 면 “회사 ID”를 의미합니다.
eventId	string	Y	웹훅이 어떤 행위에 의해 발생했는지(= 트리거) 식별하기 위한 값으로, 웹훅이 고유한 값을 가지는 것은 아닙니다. ex) 고객을 생성하면, “event: 생성”과 “event: 수정”이 같이 발생하며 이들 웹훅은 “고객 생성”이라는 트리거를 식별하고자 동일한 eventId를 가질 수 있습니다. ex) 고객을 병합하면, “event: 삭제”과 “event: 병합”이 같이 발생하며 이들 웹훅은 “고객 병합”이라는 트리거를 식별하고자 동일한 eventId를 가질 수 있습니다.
fieldName	string	N	event가 수정인 경우 값이 존재하며 그 외의 경우 undefined 값을 가집니다. 어떤 필드에 대한 수정 웹훅인지를 나타냅니다.
beforeField	any	N	event가 수정인 경우 값이 존재하며 그 외의 경우 undefined 값을 가집니다. fieldName에 해당하는 필드가 수정되기 전 값을 나타냅니다. - 필드가 데이터 암호화 사용이 활성화 되어 있으면 암호화된 데이터 라는 상수 값을 가집니다. - 필드가 비어 있으면 null 값을 가집니다. - 필드가 True / False 유형이면 boolean 값을 가집니다. - 필드가 날짜 유형이면 ‘YYYY-MM-DD’ 형식의 string 값을 가집니다. - 필드가 날짜 (시간) 유형이면 ‘YYYY-MM-DD 오전/오후 hh시 mm분’ 형식의 string 값을 가집니다. - 필드가 숫자 유형이면 number 값을 가집니다. - 필드가 텍스트 유형 또는 단일 선택유형이면 string 값을 가집니다. - 필드가 복수 선택 유형이면 string[] 값을 가집니다. - 필드가 XXX(단일) 유형( 회사 (단일), 고객 (단일), 사용자 (단일) 등)이면 {id: string; name: string;} 값을 가집니다. id는 해당 유형의 식별자 (회사 (단일) 유형이면 “회사 ID”, 고객 (단일) 유형이면 “고객 ID”, 사용자 (단일) 유형이면 “사용자ID”를 의미합니다. name은 해당 유형의 이름 (회사 (단일) 유형이면 “회사 이름”, 고객 (단일) 유형이면 “고객 이름”, 사용자 (단일) 유형이면 “사용자이름”을 의미합니다. 필드가 XXX(복수) 유형( 회사 (복수), 고객 (복수), 사용자 (복수) 등)이면 {id: string; name: string;}[] 값을 가집니다. id는 해당 유형의 식별자 (회사 (단일) 유형이면 “회사 ID”, 고객 (단일) 유형이면 “고객 ID”, 사용자 (단일) 유형이면 “사용자ID”를 의미합니다. name은 해당 유형의 이름 (회사 (단일) 유형이면 “회사 이름”, 고객 (단일) 유형이면 “고객 이름”, 사용자 (단일) 유형이면 “사용자이름”을 의미합니다.
afterField	any	N	event가 수정인 경우 값이 존재하며 그 외의 경우 undefined 값을 가집니다. fieldName에 해당하는 필드의 수정된 값을 나타냅니다. 필드가 데이터 암호화 사용이 활성화 되어 있으면 암호화된 데이터 라는 상수 값을 가집니다. 필드가 비어 있으면 null 값을 가집니다. 필드가 True / False 유형이면 boolean 값을 가집니다. 필드가 날짜 유형이면 ‘YYYY-MM-DD’ 형식의 string 값을 가집니다. 필드가 날짜 (시간) 유형이면 ‘YYYY-MM-DD 오전/오후 hh시 mm분’ 형식의 string 값을 가집니다. 필드가 숫자 유형이면 number 값을 가집니다. 필드가 텍스트 유형 또는 단일 선택 유형이면 string 값을 가집니다. 필드가 복수 선택 유형이면 string[] 값을 가집니다. 필드가 XXX(단일) 유형( 회사 (단일), 고객 (단일), 사용자 (단일) 등)이면 {id: string; name: string;} 값을 가집니다. id는 해당 유형의 식별자 (회사 (단일) 유형이면 “회사 ID”, 고객 (단일) 유형이면 “고객 ID”, 사용자 (단일) 유형이면 “사용자ID”를 의미합니다. name은 해당 유형의 이름 (회사 (단일) 유형이면 “회사 이름”, 고객 (단일) 유형이면 “고객 이름”, 사용자 (단일) 유형이면 “사용자이름”을 의미합니다. 필드가 XXX(복수) 유형( 회사 (복수), 고객 (복수), 사용자 (복수) 등)이면 {id: string; name: string;}[] 값을 가집니다. id는 해당 유형의 식별자 (회사 (단일) 유형이면 “회사 ID”, 고객 (단일) 유형이면 “고객 ID”, 사용자 (단일) 유형이면 “사용자ID”를 의미합니다. name은 해당 유형의 이름 (회사 (단일) 유형이면 “회사 이름”, 고객 (단일) 유형이면 “고객 이름”, 사용자 (단일) 유형이면 “사용자이름”을 의미합니다.