イベント

mixi2 からアプリケーションに送信されるイベントの種類と構造を解説します。

mixi2 では、ユーザーがアプリケーションにメンションしたり、DM を送信したりすると、その情報がイベントとしてアプリケーションサーバーに配信されます。このページでは、イベントの種類と構造について説明します。

前提条件

アプリケーションが受信できるイベントは以下の通りです。

イベント種別	説明
`EVENT_TYPE_PING`	接続確認用のイベント
`EVENT_TYPE_POST_CREATED`	ポストが作成されたときに発生
`EVENT_TYPE_CHAT_MESSAGE_RECEIVED`	チャット/DM メッセージを受信したときに発生

ユーザーがアプリケーションにメンション、リプライ、または引用を行った場合に発生します。

event_reason_list には、イベントが発生した理由が含まれます。

ユーザーがアプリケーションに DM を送信した場合に発生します。

event_reason_list には、イベントが発生した理由が含まれます。

イベント理由（EventReason）	説明
`EVENT_REASON_DIRECT_MESSAGE_RECEIVED`	チャット/ダイレクトメッセージを受信した

イベントを受信するには、gRPC ストリーム方式と Webhook 方式の 2 つの方法があります。それぞれの詳細は以下のページを参照してください。

方式	用途	ガイド
gRPC ストリーム	リアルタイム監視。ローカル開発に適しています	gRPC ストリーム
HTTP Webhook	HTTPS に対応したサーバー環境	Webhook

イベント処理を実装する際は、以下の特性を考慮してください。

イベントの処理順序は保証されません。イベントが発生した順序とは異なる順番で届く可能性があるため、特定の順序に依存しない設計にしてください。

イベントは Best-effort で配信されます。

Webhook 方式ではリトライによりイベントが重複して届く場合があるため、アプリケーション側で冪等性を考慮した設計を行ってください。