Skip to main content
POST https://xquik.com/api/v1/webhooks
Free. This endpoint does not consume credits.

Headers

Body

Valid event types

Valid types are tweet.new, tweet.quote, tweet.reply, tweet.retweet, tweet.media, tweet.link, tweet.poll, tweet.mention, tweet.hashtag, tweet.longform. Valid types are also profile.avatar.changed, profile.banner.changed, profile.name.changed, profile.username.changed, profile.bio.changed, profile.location.changed, profile.url.changed, profile.verified.changed, profile.protected.changed, profile.pinned_tweet.changed. Valid types are also profile.unavailable.changed, tweet.deleted, broadcast.started, space.started, following.added, following.removed, follower.added, follower.removed, profile.followers.changed, profile.following.changed. Post monitor types are post.reply.new, post.quote.new, post.likes.changed, post.retweets.changed, post.replies.changed, post.quotes.changed, post.bookmarks.changed, post.views.changed, post.edited & post.deleted. A webhook takes up to 40 types.

tweet.new

Original tweet from an account monitor or matching keyword monitor. Use for new posts that are not replies, quotes, or retweets.

tweet.quote

Quote tweet from an account monitor or matching keyword monitor. Pair with monitors that include tweet.quote.

tweet.reply

Reply from an account monitor or matching keyword monitor. Pair with monitors that include tweet.reply.

tweet.retweet

Retweet from an account monitor or matching keyword monitor. Pair with monitors that include tweet.retweet.
Only the Test Webhook endpoint sends webhook.test. You cannot subscribe to it in eventTypes.

Integration handoff

Use this endpoint after you create a monitor. For an account monitor, call POST /monitors. For a keyword monitor, call POST /monitors/keywords. The webhook stores the HTTPS endpoint and event-type filter. Active monitors produce the events. Monitor billing includes webhook delivery. Store these fields right after creation.

Webhook ID

Store id for POST /webhooks/{id}/test, updates, deletes, and delivery lookups.

Delivery URL

Store url to audit which queue, CRM, warehouse, or app endpoint receives monitor events.

Event filter

Store eventTypes. Also keep the webhook filter aligned with the account or keyword monitor event types.

Signing secret

Store secret once and use it to verify X-Xquik-Signature on the raw request body.

Created at

Store createdAt for audit logs and later configuration checks.

Delivery payload

Expect HTTPS POST bodies with eventType, schemaVersion, deliveryId, streamEventId, occurredAt, and data. Bodies also have username for account monitor events or query for keyword monitor events.
Every delivery includes X-Xquik-Signature, X-Xquik-Timestamp, and X-Xquik-Nonce headers. Use deliveryId as the per-endpoint idempotency key. Use streamEventId when you must process one monitor event once across retries or endpoints.Test the endpoint with POST /webhooks/{id}/test before routing production events. Return a 2xx response within 10 seconds. Process slow Slack, CRM, warehouse, or queue work afterward. Use Signature Verification to validate the raw request body before processing.

Response

201 Created

The API returns secret once. Store it in a secret manager. You need it to verify webhook signatures. You cannot retrieve it again.

401 Unauthenticated

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

400 Invalid input

{ "error": "invalid_input", "message": "Invalid URL or event types" } Invalid URL (must be HTTPS) or empty eventTypes array.

429 Rate limited

Too many requests. Wait for the Retry-After header before retrying.
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. List Webhooks · Signature Verification · Webhooks Overview

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 }