Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions x-api/activity/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,6 @@ The X Activity API (XAA) endpoint group allows developers to tap in to activity

A developer can subscribe to events they are interested in such as `profile.update.bio`, `profile.update.profile_picture` etc. and filter for the User ID whose events they want. The matching events for that User ID will be delivered to your app with sub-second latency.

<Warning>
The X Activity API is available as an open beta. While in open beta, please expect potential bugs, breaking changes, or incomplete features.

Your feedback is invaluable—report issues via our [developer community forums](https://devcommunity.x.com/).
</Warning>

## Delivery Mechanisms

The X Activity API currently supports the following delivery mechanisms to send events to your app:
Expand All @@ -37,21 +31,21 @@ Profile events are triggered when a user makes changes to their profile informat
| `profile.update.profile_picture` | Fired when a user updates their profile picture | `user_id` |
| `profile.update.banner_picture` | Fired when a user updates their profile banner | `user_id` |
| `profile.update.screenname` | Fired when a user updates their display name | `user_id` |
| `profile.update.handle` | Fired when a user updates their handle | `user_id` |
| `profile.update.geo` | Fired when a user updates their profile location | `user_id` |
| `profile.update.url` | Fired when a user updates their profile website URL | `user_id` |
| `profile.update.verified_badge` | Fired when a user updates their verified badge | `user_id` |
| `profile.update.affiliate_badge` | Fired when a user updates their affiliate badge | `user_id` |

### Follow Events

Follow events are triggered when a user follows or unfollows another user.
Follow events are triggered when the filtered user follows another user, or is followed by another user.

| Event Name | Description | Filters |
| --- | --- | --- |
| `follow.follow` | Fired when a user follows another user | `user_id` |
| `follow.unfollow` | Fired when a user unfollows another user | `user_id` |


### Spaces Events

Spaces events are triggered when a user starts or ends a Space.
Expand All @@ -61,14 +55,27 @@ Spaces events are triggered when a user starts or ends a Space.
| `spaces.start` | Fired when a user starts a Space | `user_id` |
| `spaces.end` | Fired when a user ends a Space | `user_id` |

### Legacy DM Events

Legacy DM events pertain to the legacy, unencrypted DM system.

| Event Name | Description | Filters |
| --- | --- | --- |
| `dm.received` | Fired when a user receives an unencrypted direct message | `user_id` |
| `dm.sent` | Fired when a user sends an unencrypted direct message | `user_id` |
| `dm.read` | Fired when a user reads the filtered users unencrypted DM message, or "read reciept" | `user_id` |
| `dm.indicate_typing` | Fired when a user is typing a message to the filtered user | `user_id` |

### Chat Events

Chat events are triggered when a user sends or receives a direct message.
Chat events pertain to the new, encrypted messaging stack, or XChat.

| Event Name | Description | Filters |
| --- | --- | --- |
| `chat.received` | Fired when a user receives a direct message | `user_id` |
| `chat.sent` | Fired when a user sends a direct message | `user_id` |
| `chat.received` | Fired when a user receives an encrypted direct message | `user_id` |
| `chat.sent` | Fired when a user sends an encrypted direct message | `user_id` |
| `chat.conversation_join` | Fired when a user joins an encrypted chat conversation | `user_id` |


### News Events

Expand Down
Loading