Skip to main content
X Activity API が配信するイベント(永続 HTTP ストリーム または webhook 経由)は、共通のエンベロープを共有します。
post.create
以下の例は、代表的な実際のペイロードです。フィールドの提供可否は、アカウント設定、展開、配信時点のオブジェクトの状態によって異なる場合があります。サポートされるイベントタイプと認証要件の全リストについては、はじめにを参照してください。

Post イベント

post.create

フィルター対象のユーザーが Post を作成したときに発火します。payload は Post オブジェクトで、includes には関連するユーザーやツイートが含まれる場合があります。
post.create

post.delete

フィルター対象のユーザーが Post を削除したときに発火します。payload には削除された Post ID と author ID が含まれます。
post.delete

post.mention.create

誰かがフィルター対象のユーザーを Post 内で @メンションしたときに発火します。プライベートイベント — ユーザーコンテキスト認証が必要です。
post.mention.create

Like イベント

like.create

フィルター対象のユーザーが Post に「いいね」したとき、またはそのユーザーの Post に「いいね」がついたときに発火します。プライベートイベント — ユーザーコンテキスト認証が必要です。オプションの direction フィルター(inbound または outbound)をサポートします。 payload は以下のフィールドを持つ like オブジェクトです。 includes にはいいねされた Post と関連するユーザーが含まれる場合があります。
like.create

Follow イベント

follow.follow

フィルター対象のユーザーが他のユーザーをフォローしたとき、またはフォローされたときに発火します。payload には source(フォロワー)と target(フォローされるユーザー)が含まれます。
follow.follow

follow.unfollow

フィルター対象のユーザーが他のユーザーのフォローを解除したとき、またはフォロー解除されたときに発火します。source / target の形状は follow.follow と同じです。
follow.unfollow

Profile イベント

すべての profile.update.* イベントは、before / after の共通ペイロード形状を持ちます。 サポートされるタイプ:profile.update.bioprofile.update.profile_pictureprofile.update.banner_pictureprofile.update.screennameprofile.update.handleprofile.update.geoprofile.update.urlprofile.update.verified_badgeprofile.update.affiliate_badge

profile.update.bio

フィルター対象のユーザーがプロフィール自己紹介を更新したときに発火します。
profile.update.bio

profile.update.profile_picture

フィルター対象のユーザーがプロフィール画像を更新したときに発火します。
profile.update.profile_picture

profile.update.banner_picture

フィルター対象のユーザーがプロフィールバナーを更新したときに発火します。
profile.update.banner_picture

profile.update.screenname

フィルター対象のユーザーが表示名を更新したときに発火します。
profile.update.screenname

profile.update.geo

フィルター対象のユーザーがプロフィールの所在地を更新したときに発火します。
profile.update.geo

profile.update.url

フィルター対象のユーザーがプロフィールのウェブサイト URL を更新したときに発火します。
profile.update.url

profile.update.handle

フィルター対象のユーザーが @ハンドルを更新したときに発火します。他のプロフィールイベントと同じ before / after のペイロード形状です。

profile.update.verified_badge

フィルター対象のユーザーの認証バッジが変更されたときに発火します。他のプロフィールイベントと同じ before / after のペイロード形状です。

profile.update.affiliate_badge

フィルター対象のユーザーのアフィリエイトバッジが変更されたときに発火します。他のプロフィールイベントと同じ before / after のペイロード形状です。

Chat イベント(XChat)

暗号化されたチャットのペイロードには、XChat クライアントライブラリで使用される不透明なエンコード済みフィールドが含まれます。プライベートイベント — ユーザーコンテキスト認証が必要です。

chat.received

chat.received

chat.sent

chat.sent

chat.conversation_join

ユーザーが暗号化されたチャット会話に参加したときに発火します。ペイロードの形状は他のチャットイベント(会話の識別情報とエンコードされた暗号化マテリアル)と同じです。プライベートイベント — ユーザーコンテキスト認証が必要です。

レガシー DM イベント

レガシー(暗号化されていない)DM イベント。プライベートイベント — ユーザーコンテキスト認証が必要です。

dm.sent

フィルター対象のユーザーが暗号化されていない DM を送信したときに発火します。payload には direct_message_eventsusers マップが含まれます。
dm.sent

dm.received

フィルター対象のユーザーが暗号化されていない DM を受信したときに発火します。ペイロードの形状は dm.sent と同じです(direct_message_eventsusers マップ)。プライベートイベント — ユーザーコンテキスト認証が必要です。
dm.received

dm.read

参加者がフィルター対象ユーザーの暗号化されていない DM を読んだとき(既読受信)に発火します。プライベートイベント — ユーザーコンテキスト認証が必要です。

dm.indicate_typing

参加者がフィルター対象のユーザーへメッセージを入力しているときに発火します。プライベートイベント — ユーザーコンテキスト認証が必要です。

News イベント

news.new

keyword でフィルタリングします。payload には Grok がキュレートしたニュースフィールド(カテゴリー、名称、フック、要約、コンテキスト、関連クラスタ Post 結果など)が含まれます。
news.new

Spaces イベント

spaces.start

フィルター対象のユーザーが Space を開始したときに発火します。payload にはホストの userbroadcast_id、および内部の event_type start が含まれます。
spaces.start

spaces.end

フィルター対象のユーザーが Space を終了したときに発火します。形状は spaces.start と同じで、内部の event_typeend になります。
spaces.end

Mute イベント

Mute イベントは、follow イベントと同様に source / target のユーザーペアを使用します。プライベートイベント — mute.read スコープを持つユーザーコンテキスト認証が必要です。user_id フィルターは、ミュートまたはミュート解除を実行するユーザー(ミュート対象のアカウントではない)とマッチします。

mute.mute

フィルター対象のユーザーが他のユーザーをミュートしたときに発火します。

mute.unmute

フィルター対象のユーザーが他のユーザーのミュートを解除したときに発火します。

Block イベント

Block イベントは、follow イベントと同様に source / target のユーザーペアを使用します。プライベートイベント — block.read スコープを持つユーザーコンテキスト認証が必要です。user_id フィルターは、ブロックまたはブロック解除を実行するユーザー(ブロック対象のアカウントではない)とマッチします。

block.block

フィルター対象のユーザーが他のユーザーをブロックしたときに発火します。

block.unblock

フィルター対象のユーザーが他のユーザーのブロックを解除したときに発火します。

OAuth イベント

oauth.revoke

ユーザーがアプリケーションへのアクセスを取り消したときに発火します。filter は空になる場合があります。これを利用して、取り消したユーザーのローカル状態をクリーンアップしてください。
oauth.revoke

次のステップ

はじめに

サポートされているイベントタイプ、プライバシー、認証

クイックスタート

サブスクリプションを作成してイベントを受信する

アクティビティストリーム

永続 HTTP ストリームに接続する

Webhook

アクティビティイベントを webhook URL に配信する