Skip to content

Commit af55ad7

Browse files
Merge pull request #67 from xdevplatform/main
sync from main
2 parents 8678a89 + 9dee777 commit af55ad7

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

x-api/activity/introduction.mdx

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,6 @@ The X Activity API (XAA) endpoint group allows developers to tap in to activity
1010

1111
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.
1212

13-
<Warning>
14-
The X Activity API is available as an open beta. While in open beta, please expect potential bugs, breaking changes, or incomplete features.
15-
16-
Your feedback is invaluable—report issues via our [developer community forums](https://devcommunity.x.com/).
17-
</Warning>
18-
1913
## Delivery Mechanisms
2014

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

4540
### Follow Events
4641

47-
Follow events are triggered when a user follows or unfollows another user.
42+
Follow events are triggered when the filtered user follows another user, or is followed by another user.
4843

4944
| Event Name | Description | Filters |
5045
| --- | --- | --- |
5146
| `follow.follow` | Fired when a user follows another user | `user_id` |
5247
| `follow.unfollow` | Fired when a user unfollows another user | `user_id` |
5348

54-
5549
### Spaces Events
5650

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

58+
### Legacy DM Events
59+
60+
Legacy DM events pertain to the legacy, unencrypted DM system.
61+
62+
| Event Name | Description | Filters |
63+
| --- | --- | --- |
64+
| `dm.received` | Fired when a user receives an unencrypted direct message | `user_id` |
65+
| `dm.sent` | Fired when a user sends an unencrypted direct message | `user_id` |
66+
| `dm.read` | Fired when a user reads the filtered users unencrypted DM message, or "read reciept" | `user_id` |
67+
| `dm.indicate_typing` | Fired when a user is typing a message to the filtered user | `user_id` |
68+
6469
### Chat Events
6570

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

6873
| Event Name | Description | Filters |
6974
| --- | --- | --- |
70-
| `chat.received` | Fired when a user receives a direct message | `user_id` |
71-
| `chat.sent` | Fired when a user sends a direct message | `user_id` |
75+
| `chat.received` | Fired when a user receives an encrypted direct message | `user_id` |
76+
| `chat.sent` | Fired when a user sends an encrypted direct message | `user_id` |
77+
| `chat.conversation_join` | Fired when a user joins an encrypted chat conversation | `user_id` |
78+
7279

7380
### News Events
7481

0 commit comments

Comments
 (0)