Create stream link

Creates a link to deliver FilteredStream events to the given webhook.

POST /2/tweets/search/webhooks/{webhook_id}

Try it

Create stream link

cURL

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

200

{
  "data": {
    "provisioned": true
  },
  "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.

Path Parameters

webhook_id · string · required

The webhook ID to link to your FilteredStream ruleset. The unique identifier of this webhook config.

Example:

"1146654567674912769"

Query Parameters

tweet.fields · string

A comma separated list of Tweet fields to display.

expansions · string

A comma separated list of fields to expand.

media.fields · string

A comma separated list of Media fields to display.

poll.fields · string

A comma separated list of Poll fields to display.

user.fields · string

A comma separated list of User fields to display.

place.fields · string

A comma separated list of Place fields to display.

Response

200

application/json

The request has succeeded.

data · object

Show child attributes

data. provisioned · boolean

errors · object[]

Minimum array length: 1

Show child attributes

errors. title · string · required

errors. type · string · required

errors. detail · string

errors. status · integer