Skip to main content
POST
/
2
/
activity
/
subscriptions
Create X activity subscription
curl --request POST \
  --url https://api.x.com/2/activity/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_type": "profile.update.bio",
  "filter": {
    "direction": "inbound",
    "keyword": "The President",
    "user_id": "2244994945"
  },
  "tag": "<string>",
  "webhook_id": "1146654567674912769"
}
'
{
  "data": {
    "subscription": {
      "created_at": "2023-11-07T05:31:56Z",
      "event_type": "<string>",
      "filter": {
        "direction": "inbound",
        "keyword": "The President",
        "user_id": "2244994945"
      },
      "subscription_id": "1146654567674912769",
      "updated_at": "2023-11-07T05:31:56Z",
      "tag": "<string>",
      "webhook_id": "1146654567674912769"
    },
    "total_subscriptions_for_instance_id": 123
  },
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ],
  "meta": {
    "total_subscriptions": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
event_type
enum<string>
required
Available options:
profile.update.bio,
profile.update.profile_picture,
profile.update.banner_picture,
profile.update.screenname,
profile.update.geo,
profile.update.url,
profile.update.verified_badge,
profile.update.affiliate_badge,
profile.update.handle,
news.new,
follow.follow,
follow.unfollow,
spaces.start,
spaces.end,
chat.received,
chat.sent,
chat.conversation_join,
dm.sent,
dm.received,
dm.indicate_typing,
dm.read
​
filter
object
required

An XAA subscription filter.

​
tag
string
Required string length: 1 - 200
​
webhook_id
string

The unique identifier of this webhook config.

Pattern: ^[0-9]{1,19}$
Example:

"1146654567674912769"

Response

The request has succeeded.

​
data
object
​
errors
object[]
Minimum array length: 1

An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).

​
meta
object