Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

X (Twitter) Webhooks API

The Webhooks API from X (Twitter) — 5 operation(s) for webhooks.

X (Twitter) Webhooks API is one of 23 APIs that X (Twitter) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, authentication docs, and rate-limit docs.

This API exposes 8 operations across 5 paths, and defines 15 schemas. It is described by OpenAPI 3.0.0, at version 2.161.

Requests are made against a single base URL, https://api.x.com.

8 operations 5 paths 15 schemas 2 DELETE2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.161
Base URL
https://api.x.com/2
Authentication
HTTP Bearer, OAuth 2.0, HTTP Oauth
Terms of Service
Resource Areas
1

Authentication & Security 3

X (Twitter) Webhooks API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerToken). It supports OAuth 2.0 (OAuth2UserToken) using the authorizationCode flow, exposing 21 scopes. It uses HTTP oauth authentication (UserToken).

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 2 DELETE, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Webhooks 8
GET
/2/tweets/search/webhooks
X Get Stream Links
getWebhooksStreamLinks → 200default
DELETE
/2/tweets/search/webhooks/{webhook_id}
X Delete Stream Link
deleteWebhooksStreamLink 1 param → 200default
POST
/2/tweets/search/webhooks/{webhook_id}
X Create Stream Link
createWebhooksStreamLink 7 params → 200default
GET
/2/webhooks
X Get Webhook
getWebhooks 1 param → 200default
POST
/2/webhooks
X Create Webhook
createWebhooks body → 200default
POST
/2/webhooks/replay
X Create Replay Job for Webhook
createWebhookReplayJob body → 200default
DELETE
/2/webhooks/{webhook_id}
X Delete Webhook
deleteWebhooks 1 param → 200default
PUT
/2/webhooks/{webhook_id}
X Validate Webhook
validateWebhooks 1 param → 200default

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are WebhookConfig (4 properties), Problem (4 properties), WebhookConfigCreateResponse (4 properties), Get2WebhooksResponse (3 properties). Each schema is shown below with its type and property counts.

WebhookLinksGetResponse
object
2 properties
WebhookConfigCreateRequest
object
1 property 1 required
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties 2 required
WebhookConfig
object
A Webhook Configuration
4 properties 4 required
WebhookReplayCreateRequest
object
3 properties 3 required
WebhookConfigCreateResponse
object
A Webhook Configuration
4 properties 4 required
Error
object
2 properties 2 required
WebhookConfigId
string
The unique identifier of this webhook config.
Get2WebhooksResponse
object
3 properties
WebhookConfigDeleteResponse
object
2 properties
WebhookConfigPutResponse
object
2 properties
ResultCount
integer
The number of results returned in this response.
WebhookLinksCreateResponse
object
2 properties
ReplayJobCreateResponse
object
Confirmation that the replay job request was accepted.
2 properties 2 required
WebhookLinksDeleteResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

twitter-webhooks-api-openapi.yml Raw ↑

Other APIs X (Twitter) publishes across the network.

X Ads API
X Activity API
X (Twitter) Account Activity API
X (Twitter) Activity API
X (Twitter) Bookmarks API
X (Twitter) Chat API
X (Twitter) Communities API
X (Twitter) Community Notes API
X (Twitter) Compliance API
X (Twitter) Connections API
X (Twitter) Direct Messages API
X (Twitter) General API