Create X activity subscription

Creates a subscription for an X activity event

POST /2/activity/subscriptions

Try it

Create X activity subscription

cURL

curl --request POST \
  --url https://api.x.com/2/activity/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_type": "ProfileBioUpdate",
  "filter": {
    "keyword": "The President",
    "user_id": "2244994945"
  },
  "tag": "<string>",
  "webhook_id": "1146654567674912769"
}
'

200

{
  "data": {
    "subscription": {
      "created_at": "2023-11-07T05:31:56Z",
      "event_type": "<string>",
      "filter": {
        "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: ProfileBioUpdate, ProfilePictureUpdate, ProfileBannerPictureUpdate, ProfileScreennameUpdate, ProfileGeoUpdate, ProfileUrlUpdate, ProfileVerifiedBadgeUpdate, TrendsNew

filter · object · required

An XAA subscription.

Show child attributes

filter. keyword · string

A keyword to filter on.

Required string length: 1 - 150

Example:

"The President"

filter. user_id · string

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"2244994945"

tag · string

Required string length: 1 - 200

webhook_id · string

The unique identifier of this webhook config.

Example:

"1146654567674912769"

Response

200

application/json

The request has succeeded.

data · object

Show child attributes

data. subscription · object

An XActivity subscription.

Show child attributes

data.subscription. created_at · string<date-time> · required

data.subscription. event_type · string · required

data.subscription. filter · object · required

An XAA subscription.

Show child attributes

data.subscription.filter. keyword · string

A keyword to filter on.

Required string length: 1 - 150

Example:

"The President"

data.subscription.filter. user_id · string

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"2244994945"

data.subscription. subscription_id · string · required

The unique identifier of this subscription.

Example:

"1146654567674912769"

data.subscription. updated_at · string<date-time> · required

data.subscription. tag · string

data.subscription. webhook_id · string

The unique identifier of this webhook config.

Example:

"1146654567674912769"

data. total_subscriptions_for_instance_id · integer

errors · object[]

Minimum array length: 1

Show child attributes

errors. title · string · required

errors. type · string · required

errors. detail · string

errors. status · integer

meta · object

Show child attributes

meta. total_subscriptions · integer<int32>

Number of active subscriptions.