Get stream links

Get a list of webhook links associated with a filtered stream ruleset.

GET /2/tweets/search/webhooks

Try it

Get stream links

cURL

curl --request GET \
  --url https://api.x.com/2/tweets/search/webhooks \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "links": [
      {
        "application_id": "<string>",
        "business_user_id": "<string>",
        "created_at": "<string>",
        "fields": [
          "<string>"
        ],
        "instance_id": "<string>",
        "webhook_id": "<string>"
      }
    ]
  },
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Response

200

application/json

The request has succeeded.

data · object

The list of active webhook links for a given stream

Show child attributes

data. links · object[] · required

list of links

Show child attributes

data.links. application_id · string

The application ID

data.links. business_user_id · string

The user ID

data.links. created_at · string<data-time>

The datetime the webhook was linked to the stream

data.links. fields · string[]

Requested fields to be rendered

A query-parameter formatted field or expansion, e.g., 'expansions=author_id' or 'user.fields=name,username'

data.links. instance_id · string

The stream ID associated with the FilteredStream instance

data.links. webhook_id · string

The unique identifier for the webhook

errors · object[]

Minimum array length: 1

Show child attributes

errors. title · string · required

errors. type · string · required

errors. detail · string

errors. status · integer