Monitors

Changed on

Creates an account monitor, with no count limit. Active monitors check every second for 30 credits an hour, events & webhook deliveries included. That hourly price is a monitor's only charge. Creation needs the credits of the first hour.

post/api/v1/monitors

Request

  • Base URL: https://xquik.com
  • URL: https://xquik.com/api/v1/monitors
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

usernamestring required

X username to monitor, with or without @, or the account's numeric user ID. A number is a user ID. The monitor shows the username X shows for the account.

namestring

Your label for the monitor. Its events carry it as monitorName. Xquik normalizes whitespace.

eventTypesEventType[] required

Array of event types to subscribe to.

Example request

{
  "username": "elonmusk",
  "name": "Launch watch",
  "eventTypes": [
    "tweet.new",
    "tweet.reply"
  ]
}

Response

Monitor created

idstring required
usernamestring required
xUserIdstring required
eventTypesEventType[] required

Array of event types to subscribe to.

isActiveboolean required
createdAtstring date-time required
nextBillingAtstring date-time required

Next hourly credit charge time. New active monitors are due immediately.

Example response

{
  "id": "42",
  "username": "elonmusk",
  "xUserId": "1234567890",
  "eventTypes": [
    "tweet.new",
    "tweet.reply"
  ],
  "isActive": true,
  "createdAt": "2025-01-15T12:00:00Z",
  "nextBillingAt": "2025-01-15T12:00:00Z"
}

Changes

  • 45942c75fdc2Revision changes
    • warning

      added the new topup_in_progress enum value to the ///// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the /////// response property for the response status