그로스 시나리오에서 Webhook 연동하기
Introduction
Webhook 은 Growth Scenario 내 특정 Node 를 지나가는 사용자에 대한 이벤트를 고객사의 서버로 보낼 수 있는 기능입니다. 이 기능을 통해 고객사 역시 Growth Scenario 내의 특정 node 를 지나가는 사용자에 대한 데이터를 받을 수 있습니다.
Webhook 설정
Webhook 설정을 위해서는
- Webhook 리퀘스트 실패시 규칙 설정
- Webhook Template 생성 및 설정
2 단계를 거쳐야 합니다.
Webhook 리퀘스트 실패 시 규칙 설정
Webhook Request 가 실패 시, 실패가 된 사용자의 이후 단계 참여 여부를 설정합니다.
- 다음 단계를 진행합니다.
- Webhook Request 가 실패된 사용자를 다음 단계로 이동 시켜 진행합니다.
- 다음 단계로 넘어가지 않고 유저를 이번 시나리오 사이클에서 종료(EXIT)시킵니다.
- Webhook Request 가 실패된 사용자를 다음 단계로 이동시키지 않고 종료(Exit) 시킵니다. 종료(Exit) 후 해당 사용자는 시나리오에 재 진입할 수 있습니다.
WebHook 시 서버에서 응답하는 응답 코드에 따라 실패 여부 및 재시도 여부가 결정됩니다.
재시도는 최대 3회 30초 간격으로 시도됩니다.
리퀘스트 실패 후 재시도 정책
| Response Code | 수신 여부 | 재시도 여부 |
| 20x (success) | Yes | - |
| 30x (redirection) | No | No |
| 408 (request timeout) | No | Yes |
| 429 (rate limited) | No | Yes |
| Other 4xx (client error) | No | No |
| 5xx (server error) | No | Yes |
Webhook Template 생성 및 설정
Webhook Template 생성을 위해서는 Webhook Wizard 에서 새 Webhook 탬플릿 만들기를 선택합니다.
클릭 후 넘어가는 Webhook Template 리스트 화면에서 우측 상단의 "Webhook Template 추가" 버튼을 클릭합니다.
이후 WebHook Template 의 필요한 정보를 입력합니다.
이름
해당 Webhook 의 관리용 이름을 설정합니다.
Endpoint
Webhook 데이터를 받을 서버 URL 주소를 입력합니다.
Http Method
데이터 전송 타입을 설정합니다. 타입은 GET / POST 타입을 지원합니다.
Http Header
Webhook request 에 포함될 Header 를 설정합니다.
기본 파라미터
Webhook 시 전달할 데이터를 설정합니다. Growth Action Webhook 에서는 기본적으로 아래 두 파라미터를 반드시 전송합니다.
- campaign_id : Growth Action 캠페인 ID
- revision_no : 해당 Growth Action 캠페인 버전
위 의 파라미터 외에 추가적인 데이터를 받고자 하실 경우 아래 디파이너리 매크로 리스트를 통해 사용자 기기의 정보를 Webhook 으로 받을 수 있습니다.
디파이너리 매크로 리스트
디파이너리에서 사전에 미리 설정한 매크로입니다. 해당 매크로를 입력하시면 사용자의 정보를 토대로 자동으로 값이 채워저 전송됩니다.
| 매크로 명 | Type | 설명 | Example |
| adid | string | 구글 광고 아이디 or 애플 광고 식별자 or 웹 쿠키 아이디 | 0fa27c1e-9378-4d1c-8f01-118e094240e5 |
| idfv | string | 애플 벤더 아이디 | DE4BF1F6-0D95-4F94-A56C-B94E30EB73FE |
| ad_id_opt_out | bool | 광고 추적 제한 여부 | FALSE |
| is_push_enable | bool | 푸시 활성화 유무 | TRUE |
| is_push_enable_os | bool | OS의 푸시 활성화 유무 | TRUE |
| os | string | 디바이스OS 버전 | 7 |
| model | string | 디바이스 모델네임 | LG-F800L |
| vendor | string | 디바이스 제조사 | LGE |
| resolution | string | 디바이스 해상도(가로x세로) | 800x600 |
| is_portrait | bool | 디바이스 오리엔테이션 | FALSE |
| network | string | 디바이스 네트워크 타입 | network |
| platform | enum | 디바이스 플랫폼 | 1 |
| carrier | string | 디바이스 통신사 | SK Telecom |
| language | string | 디바이스 언어 | kr |
| country | string | 디바이스 국가 | ko |
추가 파라미터
디파이너리에서 제공하는 매크로 이외에 Custom Macro 를 추가할 수 있습니다.
- 키 : Custom Macro 의 키(Key) 값을 입력합니다. 오직 문자열 (String) 만 사용할 수 있습니다.
- 타입 : 해당 Custom Macro 의 Value 에 해당하는 타입을 선택합니다. 타입은 문자열(String), 숫자형(Number) 그리고 논리형(Boolean) 을 지원합니다.
- 설명 : 해당 매크로에 대한 설명을 입력합니다.
Custom Macro 사용법
커스텀 매크로는 고객사가 직접 설정한 매크로입니다. 이 커스텀 매크로는 아래와 같이 사용하실 수 있습니다.
Example : 사용자가 아래 스크린샷과 같이 "custom" 이라는 이름의 Custom Macro 를 설정하였을 경우.
Growth Scenario 내 Webhook 설정에서 특정 node 에 맞는 값을 직접 입력하여 해당 값을 Webhook 으로 전송합니다.