Skip to main content
GET https://xquik.com/api/v1/webhooks
Free. This endpoint does not consume credits.
These examples build one row per webhook. They do not print the full response page. Split the rows by is_active and delivery_status. Then store update, delete, test, resume, 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

Query parameters

Response

200 OK

List responses never include the secret. The API returns it once at creation time.

400 Invalid cursor

{ "error": "invalid_input", "message": "Cursor invalid. Use nextCursor from the previous page, or omit it to start over." } The cursor is not one this list returned. Send the nextCursor of the previous page, or omit it.

401 Unauthenticated

Missing or invalid API key or session cookie.

429 Rate limited

{ "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 1 } Too many requests. Wait for the Retry-After header before retrying.

Inventory handoff

This endpoint shows which signed webhook endpoints the account has configured. Use it for an ops job, CRM integration, alert worker, or agent.

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 events fail.

Event filter

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

Active state

Store webhooks[].isActive. Inactive webhooks do not receive monitor events. Use deliveryStatus to distinguish paused from needs-attention receivers.

Delivery status

Store webhooks[].deliveryStatus. Alert the receiver owner on needs_attention. Xquik keeps retrying. After the fix, call Resume Webhook to start sending waiting deliveries at once.

Failure counter

Store webhooks[].consecutiveFailures and webhooks[].failureHardCap for alerting before the receiver reaches the failure cap.

Change links

For each row, link active receivers to Update Webhook and Test Webhook. Also link them to Resume 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

Store streamEventId, status, attempts, lastStatusCode, lastError, createdAt, and deliveredAt from the per-webhook deliveries endpoint.

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 later configuration checks.

Signing secret

The list omits the signing secret. Store it from Create Webhook, then verify deliveries with Signature Verification.
This endpoint accepts 2 auth methods. Send an API key in the x-api-key header. Or send a session cookie from the dashboard.Next steps.

Response examples

  • 400 { "error": "invalid_input", "message": "Invalid input. Check the request body." }
  • 401 { "error": "unauthenticated", "message": "Authentication required. Provide a valid API key or bearer token." }
  • 403 { "error": "api_key_paused", "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again." }
  • 429 { "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }