Sign in
latestOpenAPI 3.1.02026-08-19128114470.3 KB

73cd0a1d989c

Events

Get event

get/events/{id}

Path parameters

idstring required

Resource ID returned by the matching create or list endpoint.

Response

Event details

idstring required
type'tweet.new' | 'tweet.reply' | 'tweet.retweet' | 'tweet.quote' | 'tweet.media' | 'tweet.link' | 'tweet.poll' | 'tweet.mention' | 'tweet.hashtag' | 'tweet.longform' | 'profile.avatar.changed' | 'profile.banner.changed' | 'profile.name.changed' | 'profile.username.changed' | 'profile.bio.changed' | 'profile.location.changed' | 'profile.url.changed' | 'profile.verified.changed' | 'profile.protected.changed' | 'profile.pinned_tweet.changed' | 'profile.unavailable.changed' required

Type of monitor event fired when account activity occurs.

usernamestring

Account username for this detailed monitor event.

querystring

Keyword query for this detailed monitor event.

monitorIdstring required

Monitor ID associated with this detailed event payload.

monitorType'account' | 'keyword' required

Source monitor type for this detailed event.

keywordMonitorIdstring

Keyword monitor ID included on detailed keyword events.

occurredAtstring date-time required
dataPublicMetadata required

Public metadata whose fields are defined by X.

xEventIdstring

Example response

{
  "id": "42",
  "type": "tweet.new",
  "username": "elonmusk",
  "query": "xquik OR \"x api\"",
  "monitorId": "10",
  "monitorType": "account",
  "keywordMonitorId": "21",
  "occurredAt": "2025-01-15T12:00:00Z",
  "xEventId": "1234567890"
}