Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.xquik.com/llms.txt

Use this file to discover all available pages before exploring further.

Use this guide when a no-code or low-code workflow needs Xquik data without a custom backend. Pick one handoff lane, normalize IDs early, and keep webhook signing material out of shared workflow history.

​
Pick the Handoff Lane

Instant Monitor Events

Use POST /api/v1/monitors or POST /api/v1/monitors/keywords, then POST /api/v1/webhooks, when the workflow needs fresh account or keyword events.

Bulk Export Jobs

Use POST /api/v1/extractions, poll GET /api/v1/extractions, then export CSV, JSON, or XLSX when the workflow needs many rows.

Direct Read Pages

Use GET /api/v1/x/tweets/search or follower pages when the workflow owns the cursor loop and can store next_cursor.

Replay and Repair

Use GET /api/v1/events and GET /api/v1/webhooks/{id}/deliveries after receiver downtime, failed steps, or queue backpressure.

​
Instant Monitor Trigger

Create or choose the monitor first, then point a webhook at the no-code receiver URL. Test the webhook before routing alerts to Slack, Sheets, CRM, or queues. 
curl -X POST https://xquik.com/api/v1/webhooks \
  -H "x-api-key: xq_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/xquik/no-code-receiver",
    "eventTypes": ["tweet.new", "tweet.reply"]
  }' | jq

curl -X POST https://xquik.com/api/v1/webhooks/15/test \
  -H "x-api-key: xq_YOUR_KEY_HERE" | jq
Use deliveryId as the per-endpoint retry key and streamEventId when one monitor event should process once across receiver changes.

​
Bulk Export Trigger

Use extraction jobs when the workflow needs a file, a batch, or a repeatable job receipt instead of one live event. 
curl "https://xquik.com/api/v1/extractions?status=completed&limit=25" \
  -H "x-api-key: xq_YOUR_KEY_HERE" | jq

curl "https://xquik.com/api/v1/extractions/77777/export?format=csv" \
  -H "x-api-key: xq_YOUR_KEY_HERE" \
  -o xquik-export.csv
Store job.id, job.toolType, job.status, hasMore, and nextCursor before sending rows to Sheets, CRM, or warehouse modules.

​
Direct Read Loop

Use direct reads when the workflow needs a small page now and can keep cursor state in the platform’s store. 
curl "https://xquik.com/api/v1/x/tweets/search?q=xquik%20min_faves%3A10&limit=50" \
  -H "x-api-key: xq_YOUR_KEY_HERE" | jq

curl "https://xquik.com/api/v1/x/users/xquikcom/followers?pageSize=200" \
  -H "x-api-key: xq_YOUR_KEY_HERE" | jq
For tweet search, store has_next_page and next_cursor. For follower pages, store has_next_page and next_cursor, then pass next_cursor back as cursor only when more pages are required.

​
Shared Row Shape

Map every no-code receiver into one stable storage row before branching to alerts, CRM, spreadsheets, or AI review. 
{
  "workflow_id": "xquik-no-code-q2",
  "handoff_lane": "instant_monitor",
  "platform": "zapier",
  "source_route": "POST /api/v1/webhooks",
  "monitor_id": "42",
  "keyword_monitor_id": null,
  "webhook_id": "15",
  "delivery_id": "502",
  "stream_event_id": "9002",
  "event_type": "tweet.new",
  "tweet_id": "1893704267862470862",
  "user_id": "987654321",
  "username": "customer_handle",
  "retry_key": "delivery_id:502",
  "event_dedupe_key": "stream_event_id:9002",
  "replay_route": "GET /api/v1/events?after=9002",
  "received_at": "2026-05-24T20:33:00.000Z"
}
Keep API keys, endpoint signing values, raw request bodies, raw signatures, and full headers out of workflow history, sheet rows, CRM records, and queue payloads.

​
Platform Notes

Zapier

Use REST Hooks for instant monitor events and polling triggers for completed extractions or delivery failures.

Make

Use a custom app with instant webhooks, data stores, iterators, and a universal API call module for endpoints not yet modeled.

Pipedream

Use HTTP sources or component sources for monitor events, then export stable fields to later steps.

n8n

Use HTTP Request nodes, webhook triggers, and workflow state for replay, cursor, and dedupe checkpoints.

​
Cost and Retry Notes

Active account and keyword monitors check every 1 second and cost 21 credits per active monitor-hour. Event storage and webhook delivery are included.
Direct tweet search and follower pages are metered by returned rows. Store cursors so retries do not restart from page 1.
Extraction jobs return 202 with id, toolType, and status. Poll job detail or list completed jobs before exporting rows.

​
Next Steps

Brand Monitoring

Build account and keyword monitor workflows with signed webhooks and replay.

Extraction Workflow

Create extraction jobs, fetch paginated results, and export files.

Webhook Testing

Verify signed test deliveries before accepting production events.

Response Formats

Choose CSV, JSON, XLSX, PDF, or paginated JSON for downstream tools.
Last modified on May 24, 2026