Skip to main content
POST
Send X monitor alerts to a Telegram chat with a bot
Free. Connecting a chat and its messages cost no credits.
Get your monitor events in Telegram with no server of your own. The call returns a link to @XquikBot. Open it and press Start. The chat is connected.

How it works

  1. Call this endpoint. It returns a url like https://t.me/XquikBot?start=....
  2. Open the link on a phone or computer with Telegram, then press Start.
  3. @XquikBot answers “Connected.” Each new event of your monitors arrives as a message: the account and event type in bold, the post’s text or the profile change, and a link to the post.
  • A link works once, within 15 minutes. Make a new one if it expires.
  • The chat appears in List webhooks with the URL telegram:<chat ID>. Deliveries, retries, Resume and Test webhook work as for any webhook.
  • In the chat, send /stop to pause alerts and /status to check them. A new link turns them on again.
  • When Telegram asks Xquik to slow down, the retry waits as long as it asks.
  • @XquikBot works in private chats. It answers in English, Turkish or Spanish, by your Telegram language.

Body

string[]
The event types the chat gets, like tweet.new or profile.bio.changed. Omit the body or this field to get every event type.

Headers

string
required
Your API key.

Response

201 Created

string
Opens @XquikBot with the link’s code. Open it and press Start.
string
When the link stops working, 15 minutes after it was made.

400 Invalid input

An event type is unknown. Use the types the monitor endpoints list.

401 Unauthenticated

Missing or invalid API key. Check the x-api-key header value.

503 Telegram unavailable

Telegram delivery is off for now. Try again later.