Twitter Keyword Monitor Updates & Alert Controls

{
  "id": "21",
  "query": "xquik OR \"x api\"",
  "eventTypes": [
    "tweet.new"
  ],
  "isActive": true,
  "createdAt": "2025-01-15T12:00:00Z",
  "nextBillingAt": "2025-01-15T13:00:00Z"
}

{
  "error": "invalid_input",
  "message": "Invalid input. Check the request body."
}

{
  "error": "unauthenticated",
  "message": "Authentication required. Provide a valid API key or bearer token."
}

{
  "error": "not_found",
  "message": "Resource not found."
}

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Try again later.",
  "retryAfter": 60
}

PATCH

monitors

keywords

{id}

Twitter Keyword Monitor Updates & Alert Controls

curl --request PATCH \
  --url https://xquik.com/api/v1/monitors/keywords/{id} \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "eventTypes": [
    "<string>"
  ],
  "isActive": true
}
'

import requests

url = "https://xquik.com/api/v1/monitors/keywords/{id}"

payload = {
    "eventTypes": ["<string>"],
    "isActive": True
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "<content-type>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({eventTypes: ['<string>'], isActive: true})
};

fetch('https://xquik.com/api/v1/monitors/keywords/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://xquik.com/api/v1/monitors/keywords/{id}"

	payload := strings.NewReader("{\n  \"eventTypes\": [\n    \"<string>\"\n  ],\n  \"isActive\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "<content-type>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "<string>",
  "query": "<string>",
  "eventTypes": [
    "<string>"
  ],
  "isActive": true,
  "createdAt": "<string>",
  "nextBillingAt": "<string>"
}

Choose Keyword Monitor Updates

Use this route to change one keyword monitor’s event types or active state. Use get for a read-only checkpoint. Use list for account-wide keyword monitor inventory.

Free - does not consume credits

curl -X PATCH https://xquik.com/api/v1/monitors/keywords/21 \
  -H "x-api-key: xq_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "eventTypes": ["tweet.new", "tweet.reply"],
    "isActive": true
  }' |
  jq -c '{
    keyword_monitor_id: .id,
    query: .query,
    event_types: .eventTypes,
    is_active: .isActive,
    created_at: .createdAt,
    next_billing_at: .nextBillingAt,
    verify_endpoint: "/api/v1/monitors/keywords/\(.id)",
    delete_endpoint: "/api/v1/monitors/keywords/\(.id)",
    events_endpoint: "/api/v1/events?keywordMonitorId=\(.id)",
    event_detail_endpoint_pattern: "/api/v1/events/{event_id}",
    webhooks_endpoint: "/api/v1/webhooks",
    deliveries_endpoint_pattern: "/api/v1/webhooks/{webhook_id}/deliveries"
  }'

const monitorId = "21";
const response = await fetch(
  `https://xquik.com/api/v1/monitors/keywords/${monitorId}`,
  {
    method: "PATCH",
    headers: {
      "x-api-key": "xq_YOUR_KEY_HERE",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      eventTypes: ["tweet.new", "tweet.reply"],
      isActive: true,
    }),
  },
);
const monitor = await response.json();
const monitorState = {
  keyword_monitor_id: monitor.id,
  query: monitor.query,
  event_types: monitor.eventTypes,
  is_active: monitor.isActive,
  created_at: monitor.createdAt,
  next_billing_at: monitor.nextBillingAt,
  verify_endpoint: `/api/v1/monitors/keywords/${monitor.id}`,
  delete_endpoint: `/api/v1/monitors/keywords/${monitor.id}`,
  events_endpoint: `/api/v1/events?keywordMonitorId=${monitor.id}`,
  event_detail_endpoint_pattern: "/api/v1/events/{event_id}",
  webhooks_endpoint: "/api/v1/webhooks",
  deliveries_endpoint_pattern: "/api/v1/webhooks/{webhook_id}/deliveries",
};
process.stdout.write(`${JSON.stringify(monitorState)}\n`);

import json
import requests

monitor_id = "21"
response = requests.patch(
    f"https://xquik.com/api/v1/monitors/keywords/{monitor_id}",
    headers={"x-api-key": "xq_YOUR_KEY_HERE"},
    json={"eventTypes": ["tweet.new", "tweet.reply"], "isActive": True},
)
monitor = response.json()
monitor_state = {
    "keyword_monitor_id": monitor["id"],
    "query": monitor["query"],
    "event_types": monitor["eventTypes"],
    "is_active": monitor["isActive"],
    "created_at": monitor["createdAt"],
    "next_billing_at": monitor["nextBillingAt"],
    "verify_endpoint": f"/api/v1/monitors/keywords/{monitor['id']}",
    "delete_endpoint": f"/api/v1/monitors/keywords/{monitor['id']}",
    "events_endpoint": f"/api/v1/events?keywordMonitorId={monitor['id']}",
    "event_detail_endpoint_pattern": "/api/v1/events/{event_id}",
    "webhooks_endpoint": "/api/v1/webhooks",
    "deliveries_endpoint_pattern": "/api/v1/webhooks/{webhook_id}/deliveries",
}
print(json.dumps(monitor_state))

package main

import (
    "bytes"
    "encoding/json"
    "log"
    "net/http"
    "os"
)

type KeywordMonitor struct {
    ID            string   `json:"id"`
    Query         string   `json:"query"`
    EventTypes    []string `json:"eventTypes"`
    IsActive      bool     `json:"isActive"`
    CreatedAt     string   `json:"createdAt"`
    NextBillingAt string   `json:"nextBillingAt"`
}

type KeywordMonitorState struct {
    KeywordMonitorID           string   `json:"keyword_monitor_id"`
    Query                      string   `json:"query"`
    EventTypes                 []string `json:"event_types"`
    IsActive                   bool     `json:"is_active"`
    CreatedAt                  string   `json:"created_at"`
    NextBillingAt              string   `json:"next_billing_at"`
    VerifyEndpoint             string   `json:"verify_endpoint"`
    DeleteEndpoint             string   `json:"delete_endpoint"`
    EventsEndpoint             string   `json:"events_endpoint"`
    EventDetailEndpointPattern string   `json:"event_detail_endpoint_pattern"`
    WebhooksEndpoint           string   `json:"webhooks_endpoint"`
    DeliveriesEndpointPattern  string   `json:"deliveries_endpoint_pattern"`
}

func main() {
    body, _ := json.Marshal(map[string]interface{}{
        "eventTypes": []string{"tweet.new", "tweet.reply"},
        "isActive":   true,
    })

    monitorID := "21"
    req, err := http.NewRequest(
        "PATCH",
        "https://xquik.com/api/v1/monitors/keywords/"+monitorID,
        bytes.NewReader(body),
    )
    if err != nil {
        log.Fatal(err)
    }
    req.Header.Set("x-api-key", "xq_YOUR_KEY_HERE")
    req.Header.Set("Content-Type", "application/json")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        log.Fatal(err)
    }
    defer resp.Body.Close()

    var monitor KeywordMonitor
    if err := json.NewDecoder(resp.Body).Decode(&monitor); err != nil {
        log.Fatal(err)
    }
    state := KeywordMonitorState{
        KeywordMonitorID:           monitor.ID,
        Query:                      monitor.Query,
        EventTypes:                 monitor.EventTypes,
        IsActive:                   monitor.IsActive,
        CreatedAt:                  monitor.CreatedAt,
        NextBillingAt:              monitor.NextBillingAt,
        VerifyEndpoint:             "/api/v1/monitors/keywords/" + monitor.ID,
        DeleteEndpoint:             "/api/v1/monitors/keywords/" + monitor.ID,
        EventsEndpoint:             "/api/v1/events?keywordMonitorId=" + monitor.ID,
        EventDetailEndpointPattern: "/api/v1/events/{event_id}",
        WebhooksEndpoint:           "/api/v1/webhooks",
        DeliveriesEndpointPattern:  "/api/v1/webhooks/{webhook_id}/deliveries",
    }
    if err := json.NewEncoder(os.Stdout).Encode(state); err != nil {
        log.Fatal(err)
    }
}

The cURL, Node.js, Python, and Go examples convert the updated keyword monitor into one state row. Store keyword_monitor_id, query, event_types, is_active, next_billing_at, verify_endpoint, delete_endpoint, events_endpoint, event_detail_endpoint_pattern, webhooks_endpoint, and deliveries_endpoint_pattern before resuming alerts or webhook checks.

Path parameters

string

required

The unique keyword monitor ID.

Headers

string

required

Your API key. Session cookie authentication is also supported. Generate a key from the dashboard.

string

required

Must be application/json.

Body

At least 1 field is required.

string[]

Updated array of event types. Must contain at least 1 valid keyword monitor type: tweet.new, tweet.quote, tweet.reply, tweet.retweet, tweet.media, tweet.link, tweet.poll, tweet.mention, tweet.hashtag, tweet.longform.

boolean

Set to false to pause monitoring, or true to resume. Paused keyword monitors do not consume hourly monitor credits.

The monitored query is immutable. Delete this monitor and create another one to track a different query.

Update handoff

Use this endpoint when a keyword alert changes scope, needs a temporary pause, or must resume without creating a new monitor ID.

Keyword monitor update column	Request or response source	Verification rule
Monitor ID	Path `{id}` and response `id`	Require both IDs to match.
X search query	Response `query`	Confirm the immutable query stayed unchanged.
Tweet event filter	Request and response `eventTypes`	Confirm the complete replacement filter.
Polling state	Request and response `isActive`	Confirm the intended pause or resume state.
Creation time	Response `createdAt`	Preserve the original configuration timestamp.
Billing checkpoint	Response `nextBillingAt`	Recalculate the next credit review.
Webhook alignment	`GET /webhooks`	Match subscriptions before trusting alerts.

Returned State

Store returned id, query, eventTypes, isActive, createdAt, and nextBillingAt as the current keyword monitor configuration.

Event Filter

eventTypes replaces the current filter. Keep List Webhooks subscriptions aligned with the monitor event types you expect to deliver.

Pause Monitoring

isActive: false pauses keyword polling, stored events, future webhook deliveries, and hourly monitor billing for this monitor.

Resume Monitoring

isActive: true resumes polling for matching future tweets. Check nextBillingAt, then run Test Webhook before relying on production alerts.

Query Change

PATCH cannot change query. Delete this monitor and create a new keyword monitor when the X search query changes.

Downstream Join

Keep using keywordMonitorId and query from List Events to reconcile stored events and signed webhook payloads after the update. Use Get Event for one event’s full payload.

Delivery Audit

Use List Deliveries when webhook delivery evidence must be retained. Join delivery streamEventId to event IDs. Do not use x_event_id as the delivery join key.

Delete Path

Use Delete Keyword Monitor only when the query should stop permanently. Export event and delivery evidence first when support or audit workflows need history.

Response

200 OK

string

Unique keyword monitor ID.

string

Normalized X search query.

string[]

Updated event types.

boolean

Current active status after update.

string

ISO 8601 creation timestamp.

string

Next hourly credit charge time for active monitor billing.

{
  "id": "21",
  "query": "xquik api",
  "eventTypes": ["tweet.new", "tweet.reply"],
  "isActive": true,
  "createdAt": "2026-02-24T10:30:00.000Z",
  "nextBillingAt": "2026-02-24T11:30:00.000Z"
}

400 Invalid Input

{ "error": "invalid_input", "message": "Empty body, invalid event types, or invalid isActive type" }

Empty body, invalid eventTypes values, or invalid isActive type.

{ "error": "invalid_id", "message": "Invalid ID format." }

The provided monitor ID is not a valid format.

401 Unauthenticated

{ "error": "unauthenticated", "message": "Missing or invalid API key" }

Missing or invalid API key.

404 Not Found

{ "error": "not_found", "message": "Monitor not found" }

No keyword monitor exists with this ID, or it belongs to a different account.

429 Rate Limited

{ "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }

Too many requests. Wait for the Retry-After header before retrying.

Related: Get Keyword Monitor to verify state, Delete Keyword Monitor to remove it, List Events, Get Event, List Webhooks, or List Deliveries.

{
  "id": "21",
  "query": "xquik OR \"x api\"",
  "eventTypes": [
    "tweet.new"
  ],
  "isActive": true,
  "createdAt": "2025-01-15T12:00:00Z",
  "nextBillingAt": "2025-01-15T13:00:00Z"
}

{
  "error": "invalid_input",
  "message": "Invalid input. Check the request body."
}

{
  "error": "unauthenticated",
  "message": "Authentication required. Provide a valid API key or bearer token."
}

{
  "error": "not_found",
  "message": "Resource not found."
}

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Try again later.",
  "retryAfter": 60
}

Twitter Keyword Monitor Updates & Alert Controls

curl --request PATCH \
  --url https://xquik.com/api/v1/monitors/keywords/{id} \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "eventTypes": [
    "<string>"
  ],
  "isActive": true
}
'

import requests

url = "https://xquik.com/api/v1/monitors/keywords/{id}"

payload = {
    "eventTypes": ["<string>"],
    "isActive": True
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "<content-type>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({eventTypes: ['<string>'], isActive: true})
};

fetch('https://xquik.com/api/v1/monitors/keywords/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://xquik.com/api/v1/monitors/keywords/{id}"

	payload := strings.NewReader("{\n  \"eventTypes\": [\n    \"<string>\"\n  ],\n  \"isActive\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "<content-type>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "<string>",
  "query": "<string>",
  "eventTypes": [
    "<string>"
  ],
  "isActive": true,
  "createdAt": "<string>",
  "nextBillingAt": "<string>"
}

Overview

X API

X Write

Trends

Radar

Account

API Keys

Guest Wallets

Credits

X Accounts

Monitors

Events

Webhooks

Draws

Extractions

Compose

Drafts

Styles

Support

Twitter Keyword Monitor Updates & Alert Controls

Choose Keyword Monitor Updates

Path parameters

Headers

Body

Update handoff

Returned State

Event Filter

Pause Monitoring

Resume Monitoring

Query Change

Downstream Join

Delivery Audit

Delete Path

Response

200 OK

400 Invalid Input

401 Unauthenticated

404 Not Found

429 Rate Limited

​Choose Keyword Monitor Updates

​Path parameters

​Headers

​Body

​Update handoff

Returned State

Event Filter

Pause Monitoring

Resume Monitoring

Query Change

Downstream Join

Delivery Audit

Delete Path

​Response

​200 OK

​400 Invalid Input

​401 Unauthenticated

​404 Not Found

​429 Rate Limited

Choose Keyword Monitor Updates

Path parameters

Headers

Body

Update handoff

Response

200 OK

400 Invalid Input

401 Unauthenticated

404 Not Found

429 Rate Limited