Create X activity subscription

Creates a subscription for an X activity event

POST /2/activity/subscriptions

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 '
{
  "filter": {
    "keyword": "The President",
    "user_id": "2244994945"
  },
  "tag": "<string>",
  "webhook_id": "1146654567674912769"
}
'

import requests

url = "https://api.x.com/2/activity/subscriptions"

payload = {
    "filter": {
        "keyword": "The President",
        "user_id": "2244994945"
    },
    "tag": "<string>",
    "webhook_id": "1146654567674912769"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    filter: {keyword: 'The President', user_id: '2244994945'},
    tag: '<string>',
    webhook_id: '1146654567674912769'
  })
};

fetch('https://api.x.com/2/activity/subscriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.x.com/2/activity/subscriptions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'filter' => [
        'keyword' => 'The President',
        'user_id' => '2244994945'
    ],
    'tag' => '<string>',
    'webhook_id' => '1146654567674912769'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.x.com/2/activity/subscriptions"

	payload := strings.NewReader("{\n  \"filter\": {\n    \"keyword\": \"The President\",\n    \"user_id\": \"2244994945\"\n  },\n  \"tag\": \"<string>\",\n  \"webhook_id\": \"1146654567674912769\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.x.com/2/activity/subscriptions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filter\": {\n    \"keyword\": \"The President\",\n    \"user_id\": \"2244994945\"\n  },\n  \"tag\": \"<string>\",\n  \"webhook_id\": \"1146654567674912769\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.x.com/2/activity/subscriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filter\": {\n    \"keyword\": \"The President\",\n    \"user_id\": \"2244994945\"\n  },\n  \"tag\": \"<string>\",\n  \"webhook_id\": \"1146654567674912769\"\n}"

response = http.request(request)
puts response.read_body

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
  }
}

{
  "code": 123,
  "message": "<string>"
}

Authorizations

BearerTokenOAuth2UserTokenUserToken

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.

Show child attributes

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

200

application/json

The request has succeeded.

data · object

Show child attributes

errors · object[]

Minimum array length: 1

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

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Option 14

Option 15

Option 16

Option 17

Option 18

Show child attributes

meta · object

Show child attributes