Skip to main content
PATCH https://xquik.com/api/v1/webhooks/{id}
Free. This endpoint does not consume credits.
These snippets build a reconfiguration row. Store the current webhook configuration with its test and delivery-log endpoints. Do not print the full update response.

Path parameters

Headers

Body

At least 1 field is required.

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. Keep this only when your systems handle quote payloads.

tweet.reply

Reply from an account monitor or matching keyword monitor. Keep this when reply alerts or support routing should continue.

tweet.retweet

Retweet from an account monitor or matching keyword monitor. Keep this when repost activity should keep triggering deliveries.
Only the Test Webhook endpoint generates webhook.test. You cannot add it to a webhook subscription.

Response

200 OK

401 Unauthenticated

Missing or invalid API key or session cookie.

400 Invalid input

Invalid URL (must be HTTPS), empty eventTypes, or no fields provided. { "error": "invalid_id" } The provided webhook ID is not a valid format.

404 Not found

No webhook exists with this ID, or it belongs to a different account.

429 Rate limited

Too many requests. Wait for the Retry-After header before retrying.

Reconfiguration handoff

Use this endpoint when a receiver URL or event filter changes. It also pauses or resumes webhook delivery without creating a new endpoint.

Updated inventory

Store returned id, url, eventTypes, isActive, deliveryStatus, consecutiveFailures, failureHardCap, and createdAt. They are the current webhook configuration.

URL change

After changing url, run Test Webhook. Do this before expecting production monitor events at the new receiver.

Event filter

eventTypes replaces the previous list. Keep it aligned with account or keyword monitor event types.

Pause delivery

isActive: false stops future deliveries. Existing stored events and delivery records remain available. Xquik keeps queued events until all deliveries finish. Events expire 30 days after Xquik creates them.

Resume delivery

isActive: true resumes delivery for matching future monitor events. It also starts sending waiting deliveries at once. Events that happen during a pause may never arrive. To catch up, page through List Events. Use Resume Webhook when the receiver must pass a signed test first.

Signing secret

This endpoint does not rotate or return secret. Keep using the secret from Create Webhook for signature verification.

Delivery check

After the signed test passes, production monitor events may still miss the receiver. If so, use List Deliveries. Check 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 reconfiguration incident.
This endpoint accepts 2 auth methods. Send an API key in the x-api-key header. Or send a session cookie from the dashboard.Related.

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." }
  • 404 { "error": "not_found", "message": "Resource not found." }
  • 429 { "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }