Skip to main content
POST
Create Webhook

Authorizations

Authorization
string
header
required

Your OmniX API key, e.g. omnix_live_.... Billed per call.

Body

application/json
url
string
required

Your https receiver URL (http://localhost allowed for testing). Max 200 chars.

Example:

"https://your-app.com/hook"

auth_token
string
required

The X account auth_token cookie the action runs as.

Example:

"YOUR_X_AUTH_TOKEN"

encryption_code
string

Your XChat encryption code — the PIN you set when enabling encrypted chats on X. Used to recover your key so messages can be decrypted and outgoing events signed.

Example:

"YOUR_XCHAT_PIN"

events
enum<string>[]

Optional event-type allowlist. Omit to receive all types.

Available options:
message.received,
message.sent,
message.edited,
message.deleted,
message.reactionAdded,
message.reactionRemoved,
tweet.mention,
tweet.reply,
tweet.quote,
tweet.like,
tweet.retweet,
user.follow
Example:
secret
string

Optional pre-shared HMAC secret (16–128 chars). If omitted, one is generated and returned once.

Example:

"my-shared-secret-1234567890"

proxy
string

Optional outbound proxy for this call (http:// or https://, optionally user:pass@host:port). The X request runs through it — useful for geo-routing or spreading calls across IPs. SOCKS proxies are not supported.

Example:

"http://user:pass@host:8080"

Response

Registered (check valid).

status
boolean
Example:

true

data
object
error
string | null
Example:

null