ZEP 公式ガイド

thumbnail

外部通知連携

SlackやTeams、または独自構築したサーバーを通じてスペースにユーザーが接続したり、接続を終了したりする際に通知を送るアプリです。

メッセンジャー通知機能は、SlackやTeamsなどのメッセンジャーでインストール可能なIncoming Webhookを通じてチャンネルにメッセージを送る機能です。 設定する方法については以下のガイドをご参考ください。

  1. メッセージを送るチャンネルのインテグレーションで[アプリを追加する]をクリックし、Incoming Webhookをインストールします。

  1. 設定ページで[Slackに追加]をクリックし、メッセージを送るチャンネルを選択します。

  1. 詳細設定ページの[インテグレーションの設定]部分で使用するメッセージを設定します。(bot名、イメージなど) [Webhook URL]に表示されるURLをコピーしてください!

  1. ㅁ連携設定で該当URLを入力し、設定を完了します。(正常に設定された場合、メッセンジャーでテストメッセージが送信され、設定が保存されます)

  1. メッセンジャーでアプリを選択し、incoming Webhookを検索して実行します。

  1. [追加]をクリックし、メッセージを送信するチームまたはチャンネルを選択します。

  1. Incoming Webhook構成をクリックし、メッセージ設定を追加します。(bot名、イメージ)

  1. [作成]をクリックすることでURLが発行されます。

  2. 連携設定で該当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リクエスト時に当該値で置換/追加され、データが送信されます。

  • 例)https://zep.us/play/{mapHashId}?customData={"name":"ZEP", "userKey":"r1g