데이터스페이스에서 제공하는 웹훅 페이로드 구조를 설명합니다. 데이터스페이스 웹훅 정책 및 등록 방법은 가이드를 참고해 주세요.
1. 전송 구조
JSON 구조로만 전송합니다.
2. 페이로드
2.1. 응답 데이터가 포함되지 않은 경우
필드 | 설명 |
uuid | 이벤트 식별자 |
eventType | 이벤트 타입 (2024-10-30 기준 AnswerSheetSubmitted만 제공 중) |
spaceId | 설정 내 API 페이지에서 확인할 수 있는 Space ID |
UID (nullable) | 설문 설정에서 Embedded data로 URL 파라미터에 UID를 추가해서 사용한 경우, 그 입력된 값 |
surveyId | 설문 목록 조회 API로 확인할 수 있는 설문 식별자 |
collectGroupId | 수집그룹 목록 조회 API로 확인할 수 있는 수집그룹 식별자 |
startedAt | 응답을 시작한 일시, KST 기준 ISO 8601 형태로 제공 (예시: 2024-10-30T18:00:24) |
submittedAt | 응답을 제출한 일시, KST 기준 ISO 8601 형태로 제공 (예시: 2024-10-30T18:10:37) |
hmac (nullable) | 메시지의 인증을 위한 HMAC 값으로, 전송시의 HMAC 키를 사용하여 생성합니다. 즉, 재전송시 이전과 HMAC 키가 달라진다면 이 값도 달라질 수 있습니다. 인증을 위한 값 계산 과정은 가이드를 참고하세요. |
{
"uuid": "uuid_example",
"eventType": "AnswerSheetSubmitted",
"spaceId": "spaceId_example",
"UID": null,
"surveyId": "surveyId_example",
"collectGroupId": "collectGroupId_example",
"startedAt": "2024-10-30T18:00:24",
"submittedAt": "2024-10-30T18:10:37",
"hmac": "TK59QttSe-ksj0NPkWoB7B6Y4IJV13CHnT2THvziJ88="
}
2.2. 응답 데이터가 포함된 경우
필드 | 설명 |
uuid | 이벤트 식별자 |
eventType | 이벤트 타입 (2024-10-30 기준 AnswerSheetSubmitted만 제공 중) |
spaceId | 설정 내 API 페이지에서 확인할 수 있는 Space ID |
UID (nullable) | 설문 설정에서 Embedded data로 URL 파라미터에 UID를 추가해서 사용한 경우, 그 입력된 값 |
surveyId | 설문 목록 조회 API로 확인할 수 있는 설문 식별자 |
collectGroupId | 수집그룹 목록 조회 API로 확인할 수 있는 수집그룹 식별자 |
startedAt | 응답을 시작한 일시, KST 기준 ISO 8601 형태로 제공 (예시: 2024-10-30T18:00:24) |
submittedAt | 응답을 제출한 일시, KST 기준 ISO 8601 형태로 제공 (예시: 2024-10-30T18:10:37) |
embeddedData | 응답의 Embedded data 배열을 의미합니다. 응답 조회 API와 구조는 동일합니다. |
variables | 응답 내 변수 배열을 의미합니다. 응답 조회 API와 구조는 동일합니다. |
hmac (nullable) | 메시지의 인증을 위한 HMAC 값으로, 전송시의 HMAC 키를 사용하여 생성합니다. 즉, 재전송시 이전과 HMAC 키가 달라진다면 이 값도 달라질 수 있습니다. 인증을 위한 값 계산 과정은 가이드를 참고하세요. |
{
"uuid": "wev_a01jsbd416p3fa6bdzgmpj2j7dq",
"eventType": "AnswerSheetSubmitted",
"spaceId": "a01gx5bycecfr9nn6r0h85ggb44",
"UID": null,
"surveyId": "a01j9bcewppdjxemhw8ekkcty19",
"collectGroupId": "a01jqqsage29z6semn2qqpp90hf",
"startedAt": "2025-04-21T14:27:21",
"submittedAt": "2025-04-21T14:28:46",
"embeddedData": [],
"variables": [
{
"name": "Q1",
"type": "SELECT",
"label": "<p>객관식 단일</p>",
"options": [
{
"value": "-1",
"valueLabel": "<p>없음</p>"
},
{
"value": "1",
"valueLabel": "<p>보기1</p>"
},
{
"value": "2",
"valueLabel": "<p>보기2</p>"
},
{
"value": "3",
"valueLabel": "<p>보기3</p>"
},
{
"value": "-99",
"valueLabel": "<p>기타(직접 입력)</p>"
}
],
"answer": [
{
"value": "3"
}
]
},
{
"name": "Q2",
"type": "MULTI_SELECT",
"label": "<p>객관식 중복</p>",
"options": [
{
"value": "-1",
"valueLabel": "<p>없음</p>"
},
{
"value": "1",
"valueLabel": "<p>보기1</p>"
},
{
"value": "2",
"valueLabel": "<p>보기2</p>"
},
{
"value": "3",
"valueLabel": "<p>보기3</p>"
},
{
"value": "-99",
"valueLabel": "<p>기타(직접 입력)</p>"
}
],
"answer": [
{
"value": "3"
},
{
"value": "2"
}
]
},
{
"name": "Q3",
"type": "RANK_ORDER_SELECT",
"label": "<p>객관식 순위</p>",
"options": [
{
"value": "-1",
"valueLabel": "<p>없음</p>"
},
{
"value": "1",
"valueLabel": "<p>보기1</p>"
},
{
"value": "2",
"valueLabel": "<p>보기2</p>"
},
{
"value": "3",
"valueLabel": "<p>보기3</p>"
},
{
"value": "-99",
"valueLabel": "<p>기타(직접 입력)</p>"
}
],
"answer": [
{
"value": "1"
},
{
"value": "-99",
"etcValue": "기타"
}
]
},
{
"name": "Q4",
"type": "NUMERIC",
"label": "<p>주관식 숫자</p>",
"options": [],
"answer": [
{
"value": "25.0"
}
]
},
{
"name": "Q5",
"type": "TEXT",
"label": "<p>주관식 서술</p>",
"options": [],
"answer": [
{
"value": "Lorem ipsum dolor sit amet"
}
]
},
{
"name": "Q6",
"type": "DATE_TIME",
"label": "<p>주관식 날짜</p>",
"options": [],
"answer": [
{
"value": "2025-04-21"
}
]
},
{
"name": "Q7",
"type": "SHORT_TEXT",
"label": "<p>주관식 단답</p>",
"options": [],
"answer": [
{
"value": "lipsum"
}
]
},
{
"name": "Q8",
"type": "MULTI_VALUE_SHORT_TEXT",
"label": "<p>주관식 복수</p>",
"options": [],
"answer": [
{
"value": "Singular"
},
{
"value": "Plural"
}
]
},
{
"name": "Q9",
"type": "RATING_SCALE",
"label": "<p>평가형</p>",
"options": [
{
"value": "1",
"valueLabel": "<p>1L</p>"
},
{
"value": "2"
},
{
"value": "3",
"valueLabel": "<p>3L</p>"
},
{
"value": "4"
},
{
"value": "5",
"valueLabel": "<p>5L</p>"
}
],
"answer": [
{
"value": "5"
}
]
},
{
"name": "Q10_1",
"type": "RATING_SCALE",
"label": "<p>평가1</p>",
"options": [
{
"value": "1",
"valueLabel": "<p>1L</p>"
},
{
"value": "2"
},
{
"value": "3",
"valueLabel": "<p>3L</p>"
},
{
"value": "4"
},
{
"value": "5",
"valueLabel": "<p>5L</p>"
}
],
"answer": [
{
"value": "1"
}
]
},
{
"name": "Q10_2",
"type": "RATING_SCALE",
"label": "<p>평가2</p>",
"options": [
{
"value": "1",
"valueLabel": "<p>1L</p>"
},
{
"value": "2"
},
{
"value": "3",
"valueLabel": "<p>3L</p>"
},
{
"value": "4"
},
{
"value": "5",
"valueLabel": "<p>5L</p>"
}
],
"answer": [
{
"value": "2"
}
]
},
{
"name": "Q11",
"type": "RATING_SCALE",
"label": "<p>별점 평가형</p>",
"options": [
{
"value": "1",
"valueLabel": "<p></p>"
},
{
"value": "2",
"valueLabel": "<p></p>"
},
{
"value": "3"
},
{
"value": "4"
},
{
"value": "5"
}
],
"answer": [
{
"value": "4"
}
]
},
{
"name": "Q12",
"type": "NPS",
"label": "<p>NPS</p>",
"options": [
{
"value": "0",
"valueLabel": "<p>추천하지 않음</p>"
},
{
"value": "1"
},
{
"value": "2"
},
{
"value": "3"
},
{
"value": "4"
},
{
"value": "5"
},
{
"value": "6"
},
{
"value": "7"
},
{
"value": "8"
},
{
"value": "9"
},
{
"value": "10",
"valueLabel": "<p>추천</p>"
}
],
"answer": [
{
"value": "9"
}
]
},
{
"name": "Q13",
"type": "MULTI_VALUE_NUMERIC",
"label": "<p>숫자 합계형</p>",
"options": [
{
"value": "1",
"valueLabel": "<p>수1</p>"
},
{
"value": "2",
"valueLabel": "<p>수2</p>"
}
],
"answer": [
{
"value": "36.0"
},
{
"value": "64.0"
}
]
},
{
"name": "Q14",
"type": "IMAGE",
"label": "<p>이미지</p>",
"options": [],
"answer": [
{
"value": "https://dev-dataspace-answer-images.s3.ap-northeast-2.amazonaws.com/a01gx5bycecfr9nn6r0h85ggb44/a01j9bcewppdjxemhw8ekkcty19/20020857/a2615abb-acd8-47d9-bd49-123048e7461f.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250421T052935Z&X-Amz-SignedHeaders=host&X-Amz-Credential=AKIAQJJNVRLVNP3WTAUM%2F20250421%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Expires=900&X-Amz-Signature=db763b5d3436216d6393fabce29b608acc6ae50f7546969c13eac8a55612e236"
}
]
}
],
"hmac": "vDGMmWVOISrqlvaa_KrIZ4_1cPCpeuf3Y9PO9iCQ2HQ="
}