Channel Developers

thumbnail

Webhook Events

チャネルは現在、メッセージ作成(message creation)イベントのみを提供しています。今後、イベントを追加していく予定です。

特定のイベントが発生すると、登録されたURLに対して、JSON形式のデータを含む本文でPOSTリクエストを送信します。イベントのJSON構造は以下の通りです。

  • event:"upsert"、"update"、"push" など、イベントのアクション(動作)を表します。

  • type:イベントの対象となるモデルです。現在は "Message"、"UserChat"、"User" があります。

  • entity:その type に対応する実際のモデルデータです。

  • refers:他に参照すべき関連モデルがある場合、そのオブジェクトが含まれます。

チャット(チームチャットまたはユーザーチャット)でメッセージが作成されると、Webhookで通知されます。Webhookにキーワードを登録している場合は、新着メッセージにそのキーワードのいずれかが含まれている場合のみ通知されます。 リクエストボディの entity は、Messageオブジェクトになります。

  • MessageのchatType:"group" または "userChat"

  • MessageのpersonType:"manager" 、 "bot" または "user"

このイベントを利用することで、特定のメッセージに反応するチャットボットを作成できます。必要に応じて、「Quick-reply for a Webhook」を利用することも可能です。

JSON

新しいユーザーチャットが作成された際に通知されます。Webhookにキーワードを登録している場合は、新しいメッセージにそのキーワードのいずれかが含まれている場合のみ通知されます。

このイベントを利用することで、そのユーザーチャットにチームメンバーを割り当てたり、自動返信を行ったりできます。Refers フィールドには、ユーザー情報(User または Veil)と、そのユーザーチャット内の最新メッセージが含まれます。

JSON

ユーザーの連絡先(メールアドレス、携帯電話番号)や、プッシュ通知・広告設定の更新による変更を通知します。

JSON