Skip to main content
GET
/
webhooks
List webhooks
curl --request GET \
  --url https://xquik.com/api/v1/webhooks \
  --header 'x-api-key: <api-key>'

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.

Free - does not consume credits
curl https://xquik.com/api/v1/webhooks \
  -H "x-api-key: xq_YOUR_KEY_HERE" \
  | jq '.webhooks[] | {
    webhook_id: .id,
    url,
    event_types: .eventTypes,
    is_active: .isActive,
    created_at: .createdAt,
    update_endpoint: ("/api/v1/webhooks/" + .id),
    delete_endpoint: ("/api/v1/webhooks/" + .id),
    test_endpoint: ("/api/v1/webhooks/" + .id + "/test"),
    deliveries_endpoint: ("/api/v1/webhooks/" + .id + "/deliveries"),
    signing_secret_available: false
  }'
These examples shape one inventory row per webhook instead of printing the full response page. Split the rows by is_active, then store update, delete, test, and delivery-log endpoints with each receiver. List responses never include the signing secret; keep the one-time secret from Create Webhook in your secret manager.

​
Headers

​
x-api-key
string
required
Your API key. Session cookie authentication is also supported.

​
Response

​
webhooks
array
List of webhook objects for your account. Returns up to 200 webhooks.
{
  "webhooks": [
    {
      "id": "15",
      "url": "https://your-server.com/webhook",
      "eventTypes": ["tweet.new", "tweet.reply"],
      "isActive": true,
      "createdAt": "2026-02-24T10:30:00.000Z"
    },
    {
      "id": "16",
      "url": "https://backup.example.com/xquik",
      "eventTypes": ["tweet.new"],
      "isActive": false,
      "createdAt": "2026-02-20T08:15:00.000Z"
    }
  ]
}
The secret is never included in list responses. It is only returned once at creation time.

​
Inventory handoff

Use this endpoint when an ops job, CRM integration, alert worker, or agent needs to reconcile which signed webhook endpoints are configured for the account.

Configuration ID

Store webhooks[].id for updates, deletes, test deliveries, and delivery history lookups.

Delivery Target

Store webhooks[].url so configuration reviews can detect stale receiver endpoints before production monitor events fail.

Event Filter

Store webhooks[].eventTypes and compare it with monitor event types before expecting tweet.new, tweet.quote, tweet.reply, or tweet.retweet.

Active State

Store webhooks[].isActive; inactive webhooks do not receive monitor events and must be reactivated before testing.

Change Links

For each row, link active receivers to Update Webhook, Test Webhook, and List Deliveries. Link stale receivers to Delete Webhook.

Inactive Review

Inactive rows are configuration records, not active delivery targets. Keep their webhooks[].id so deactivation receipts and rollback plans can find the same webhook.

Delivery Audit

Use the per-webhook deliveries endpoint to store streamEventId, status, attempts, lastStatusCode, lastError, createdAt, and deliveredAt.

Event Join

Use delivery streamEventId as the {id} for Get Event. Store monitorId, monitorType, type, occurredAt, and data with the inventory audit.

Created At

Store webhooks[].createdAt for audit logs and configuration drift checks.

Signing Secret

The signing secret is not listed. Store it from Create Webhook, then verify deliveries with Signature Verification.
This endpoint supports dual authentication: API key (x-api-key header) or session cookie from the dashboard.Next steps: Create Webhook · Update Webhook · Test Webhook · List Deliveries · Get Event · Delete Webhook
Last modified on May 21, 2026