Webhooks
Update Twitter webhook endpoint & event filters
Change a webhook’s HTTPS URL, tweet, follower, profile, relationship, or keyword event filters, and active delivery state. Includes exact API examples.
- 200
- 400
- 401
- 404
- 429
PATCH
Update Twitter webhook endpoint & event filters
Free - does not consume credits
Path parameters
string
required
The webhook ID to update.
Headers
string
required
Your API key. This endpoint also accepts session cookie authentication.
string
required
Must be
application/json.Body
At least 1 field is required.string
New HTTPS endpoint URL. HTTP URLs are rejected.
string[]
Updated event types to subscribe to. Replaces the existing list. At least 1
required when provided. Use any valid account monitor event type listed below.
Keyword monitor webhooks should stay on
tweet.* event types. Account monitor
webhooks can use both tweet.* and profile.* event types.Valid event types
Valid types:tweet.new, tweet.quote, tweet.reply, tweet.retweet,
tweet.media, tweet.link, tweet.poll, tweet.mention, tweet.hashtag,
tweet.longform, 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,
profile.unavailable.changed.
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 downstream 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.
webhook.test is generated only by the Test Webhook endpoint. It cannot be added to a webhook subscription.boolean
Set to
false to pause deliveries. Set to true to reactivate a paused
webhook and reset consecutiveFailures. When deliveryStatus is
needs_attention, use Resume Webhook so the
receiver must pass a signed test first.Response
200 OK
string
Unique webhook identifier.
string
The current delivery endpoint URL.
string[]
Event types this webhook is subscribed to.
boolean
Whether the webhook is currently active.
number
Consecutive delivery failures recorded for this webhook.
string
active, paused, or needs_attention.number
Failure count where the webhook needs attention before resuming.
string
ISO 8601 creation timestamp.
401 Unauthenticated
400 Invalid input
eventTypes, or no fields provided.
404 Not found
429 Rate limited
Retry-After header before retrying.
Reconfiguration handoff
Use this endpoint when a receiver URL changes, an event filter changes, or an operator needs to pause or resume webhook delivery without creating a new endpoint.Updated inventory
Store returned
id, url, eventTypes, isActive, deliveryStatus,
consecutiveFailures, failureHardCap, and createdAt as the current
webhook configuration.URL change
After changing
url, run Test Webhook 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.Resume delivery
isActive: true resumes delivery for matching future monitor events. Test
the receiver after resuming. Use
Resume Webhook when the receiver needs a
signed test gate 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, use
List Deliveries if production monitor
events still miss the receiver. 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 supports dual authentication: API key (
x-api-key header) or session cookie from the dashboard.Related. List Webhooks · Test Webhook · Resume Webhook · List Deliveries · Get Event · Delete Webhook- 200
- 400
- 401
- 404
- 429
Update Twitter webhook endpoint & event filters