You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: x-api/activity/introduction.mdx
+18-11Lines changed: 18 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,12 +10,6 @@ The X Activity API (XAA) endpoint group allows developers to tap in to activity
10
10
11
11
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.
12
12
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
-
19
13
## Delivery Mechanisms
20
14
21
15
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
37
31
|`profile.update.profile_picture`| Fired when a user updates their profile picture |`user_id`|
38
32
|`profile.update.banner_picture`| Fired when a user updates their profile banner |`user_id`|
39
33
|`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`|
40
35
|`profile.update.geo`| Fired when a user updates their profile location |`user_id`|
41
36
|`profile.update.url`| Fired when a user updates their profile website URL |`user_id`|
42
37
|`profile.update.verified_badge`| Fired when a user updates their verified badge |`user_id`|
43
38
|`profile.update.affiliate_badge`| Fired when a user updates their affiliate badge |`user_id`|
44
39
45
40
### Follow Events
46
41
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.
48
43
49
44
| Event Name | Description | Filters |
50
45
| --- | --- | --- |
51
46
|`follow.follow`| Fired when a user follows another user |`user_id`|
52
47
|`follow.unfollow`| Fired when a user unfollows another user |`user_id`|
53
48
54
-
55
49
### Spaces Events
56
50
57
51
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.
61
55
|`spaces.start`| Fired when a user starts a Space |`user_id`|
62
56
|`spaces.end`| Fired when a user ends a Space |`user_id`|
63
57
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
+
64
69
### Chat Events
65
70
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.
67
72
68
73
| Event Name | Description | Filters |
69
74
| --- | --- | --- |
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`|
0 commit comments