Webhooks
List Twitter webhook endpoints & event filters
List up to 200 webhook endpoints with URLs, event filters, active states, delivery status, failure counts, and creation times. The signing secret never appears.
- 200
- 400
- 401
- 429
GET
List Twitter webhook endpoints & event filters
Free. This endpoint does not consume credits.
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
string
required
Your API key. Session cookie authentication is also supported.
Query parameters
integer
Maximum items per page: 1 to 200, default 200.
string
nextCursor from the previous page. The after alias also works. Offset pagination is not
supported.Response
200 OK
array
List of webhook objects for your account. Returns up to 200 webhooks per page.
Webhook object fields.
string
Unique webhook identifier.
string
Delivery endpoint URL.
string[]
Event types this webhook subscribes to.
boolean
Whether the webhook is active.
number
Consecutive delivery failures recorded for this webhook.
string
active, paused, or needs_attention.number
Failure count that sets
needs_attention. Delivery continues past it.string
ISO 8601 creation timestamp.
boolean
Whether more rows follow this page.
string
Pass it as
cursor for the next page. Present when hasMore is true.secret. The API returns it once at creation time.
400 Invalid cursor
cursor is not one this list returned. Send the nextCursor of the previous page, or omit it.
401 Unauthenticated
429 Rate limited
Retry-After header before retrying.
Inventory handoff
Use this endpoint when an ops job, CRM integration, alert worker, or agent needs to check which signed webhook endpoints the account has configured.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. 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, Test Webhook,
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
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 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 a session cookie from the dashboard.Next steps. Create Webhook · Update Webhook · Test Webhook · Resume Webhook · List Deliveries · Get Event · Delete Webhook