그로스 시나리오에서 Webhook 연동하기
Introduction
Webhook 은 Growth Scenario 내 특정 Node 를 지나가는 사용자에 대한 이벤트를 고객사의 서버로 보낼 수 있는 기능입니다. 이 기능을 통해 고객사 역시 Growth Scenario 내의 특정 node 를 지나가는 사용자에 대한 데이터를 받을 수 있습니다.
Webhook 연동
Webhook 연동을 위해서는
- 연동하실 서버의 URL endpoint 설정
- HMAC SHA-256 key 받기
- HTTP Header 설정
- 데이터를 받을 Template 생성
4 단계를 거쳐야 합니다.
URL endpoint
Webhook 데이터를 받을 서버 URL 주소를 입력합니다. 데이터 전송은 GET / POST 타입을 지원합니다.
HMAC SHA-256 key 발급
이 UUID 형태의 key는 디파이너리가 전송하는 Webhook 데이터를 인증하기 위한 key 입니다. 해당 key 를 통해 디파이너리가 전송하는 Webhook 데이터가 정상인지 여부를 인증합니다.
HTTP Header
Webhook request 에 포함될 Header 를 설정합니다.
ABX WEBHOOK CREDENTIAL 은 필수로 지정되어 있습니다. ABX WEBHOOK CREDENTIAL 에 전달되는 값은 Template 에 설정된 데이터(request Body or Querystring 값을 plan text 한 값) 를 위에서 발급한 HMAC SHA-256 key 로 암호화 한 값으로 데이터를 전달받을 서버에서 똑같은 방법으로 암호화 하고 이를 비교하여 데이터의 유효성을 검증합니다.
Template 생성
Webhook 으로 전달할 데이터를 설정합니다. 데이터 전송 방식에 따라 JSON (POST) / Querystring (GET) 으로 나뉘어 집니다. 사전에 미리 정의된 Adbrix 매크로와 고객사가 설정한 Custom 매크로로 이를 설정합니다.
Adbrix 매크로 리스트
Adbrix 에서 사전에 미리 설정한 매크로입니다. 해당 매크로를 입력하시면 사용자의 정보를 토대로 자동으로 값이 채워저 전송됩니다.
Adbrix 매크로 리스트
| 매크로 명 | 설명 | Example |
| {abx:adid} | 사용자의 GAID / IDFA 값 | 8e10e13a-e738-4aed-bed8- 08d7cd092d7b |
| {abx:idfv} | 사용자의 IDFV 값 | DE4BF1F6-0D95-4F94-A56C-B94E30EB73FE |
| {abx:ad_id_opt_out} | 사용자 기기의 GAID 사용 여부 | false |
| {abx:is_push_enable} | 사용자가 앱 내 push 사용 여부 | true |
| {abx:is_push_enable_os} | 사용자의 기기 내 push 사용 여부 | true |
| {abx:os} | 사용자의 기기 OS 버전 | 16.4 |
| {abx:model} | 사용자의 기기 모델명 | SM-N981 |
| {abx:vendor} | 사용자 기기의 제조사명 | Samsung |
| {abx:resolution} | 사용자 기기의 해상도 | 2400 x 1080 |
| {abx:is_portrait} | 사용자 기기의 오리엔테이션 | true |
| {abx:platform} | 사용자 기기의 플랫폼 | 1 : Android / 2 : iOS / 3 : Web |
| {abx:network} | 사용자 기기의 사용 네트워크 | wifi |
| {abx:carrier} | 사용자 기기의 통신사 | SKT |
| {abx:language} | 사용자 기기의 언어 설정 | kr |
| {abx:country} | 사용자 기기의 국가 설정 | ko |
Custom Macro 사용법
커스텀 매크로는 고객사가 직접 설정한 매크로입니다. 이 커스텀 매크로는 아래와 같이 사용하실 수 있습니다.
Example : 사용자가 아래 스크린샷과 같이 {custom_macro} 를 설정하였을 경우.
Growth Scenario 내 Webhook 설정에서 특정 node 에 맞는 값을 직접 입력하여 해당 값을 Webhook 으로 전송합니다.