외부 알림 연결
슬랙이나 팀즈 또는 자체 구축한 서버로 스페이스에 사용자들이 접속, 접속 종료 등의 이벤트가 발생할 때 알림을 보내주는 앱 입니다.
메신저 알림 기능은 Slack, Teams 등의 메신저에서 설치 가능한 Incoming Webhook을 통해 채널에 메시지를 보내주는 기능입니다. 아래 가이드를 참고해 설정을 진행해 주시기 바랍니다.
메시지를 보낼 대화방의 설정에서 [앱 추가]를 실행하여 Incoming Webhook을 검색하여 설치를 실행합니다.
설정 페이지에서 [Slack에 추가]를 누르고, 메시지를 보낼 대화 방을 입력 후 다음으로 진행합니다.
상세 설정 페이지에서 [통합 앱 설정] 부분에서 이용하실 메시지 설정을 추가합니다. (bot이름, 이미지) [웹후크 URL]에 표시되는 URL을 복사해 주세요!
연결 설정에서 해당 url을 입력하여 설정을 완료합니다. (정상적으로 설정되면 메신저로 테스트 메시지가 전송되며 설정이 저장됩니다)
메신저에서 앱을 선택한 후 incoming Webhook을 검색하여 실행합니다.
앱 추가를 누른 후 메시지를 보낼 팀 또는 채널을 선택합니다.
Incomming Webhook 구성을 클릭한 후 메시지 설정을 추가합니다. (bot이름, 이미지)
만들기를 누르면 url이 발행됩니다.
연결 설정에서 해당 url을 입력하여 설정을 완료합니다. (정상적으로 설정되면 메신저로 테스트 메시지가 전송되며 설정이 저장됩니다)
자체 서버를 구축하여 ZEP에서 발송 가능한 알림을 수신하고자 할 경우 아래의 가이드를 참고해 주시기 바랍니다.
환경 설정 방법
요청 방식은
POST메소드를 사용하며, 전송 메세지는JSON형태입니다.프로토콜(포트)는 HTTPS(443)입니다.
요청헤더의 Content-Type은
Content-type: application/json가 지정됩니다.연동 시 정상 응답을
success로 보내주셔야 연동이 됩니다.
전송 데이터 형식
Copy
데이터 설명
Key | Value |
date | 이벤트 발생 시각 |
eventType | 이벤트 유형 - enter: 접속 (맵간 이동 포함) - exit: 접속 종료 (맵간 이동 포함) |
nickname | 접속 시 customUrl에서 입력된 name (또는) 이용자의 닉네임 |
userKey | 접속 시 customUrl에서 입력된 userKey |
map_hashID | 접속한 맵의 ID |
userId | 접속한 사용자의 ID |
[외부 알림 앱]을 실행하여, API 연결을 눌러 POST 요청을 보낼 url 주소를 포함해 설정 후 알림을 활성화 해주세요.
CustomData 사용
맵 주소(url)에
customData(name, userKey 등)를 포함하면 POST 요청 시 해당 값으로 대체/추가 되어 데이터가 전송됩니다.e.g.)
https://zep.us/play/{mapHashId}?customData={"name":"ZEP", "userKey":"r1gJMA"}