ProfileBioUpdate, ProfilePictureUpdate 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.
Delivery Mechanisms
The X Activity API currently supports the following delivery mechanisms to send events to your app:- Persistent HTTP stream
- Webhook
Supported Event Types
Currently, X Activity API supports the following event types, organized by category:Profile Events
Profile events are triggered when a user makes changes to their profile information.| Event Name | Description | Filters |
|---|---|---|
profile.update.bio | Fired when a user updates their profile bio | user_id |
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.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.screenname | Fired when a user updates their display name | user_id |
profile.update.verified_badge | Fired when a user updates their verified badge | user_id |
Follow Events
Follow events are triggered when a user follows or unfollows 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 |
Enterprise Only: Follow events are only available to select Enterprise and Partner tier accounts at this time.
News Events
News events provide updates on news topics and headlines curated by Grok.| Event Name | Description | Filters |
|---|---|---|
news.new | New grok-curated news and headlines | keyword |
Enterprise Only: News events are only available to select Enterprise and Partner tier accounts at this time.
Note: XAA does not deliver posts. For real-time post delivery, see our Filtered Stream endpoint, which allows developers to filter for and stream posts in real-time.
Event Privacy and Authentication
The X Activity API distinguishes between public events and private events as at parity with the X app as explained below.Public Events
Public events are activities that a public user account perform publicly that are visible to all X users. These events are visible to all users on the X platform and don’t require OAuth authentication from the user in order to view. Current public events:- Profile updates (bio, picture, banner, location, URL, username changes)
Private Events
Private events are activities that require explicit user consent through OAuth authentication. A User has to authenticate via X and give explicit permission to a developer app to access these events. Authentication requirements for private events:- The user must authenticate your application via OAuth 2.0
- Your application must obtain appropriate OAuth scopes
- The user must explicitly grant permission for your app to access these events
- Subscriptions for private events can only be created for users who have authorized your application
Subscription Limits
The X Activity API has different subscription limits based on your account tier:| Package Tier | Maximum Subscriptions |
|---|---|
| Free | Not Available |
| Basic | 50 |
| Pro | 2500 |
| Enterprise | 50,000 |
| Partner | 100,000 |
Account setupTo access these endpoints, you will need:
- An approved developer account.
- To authenticate using the keys and tokens from a developer App that is located within a Project.