POST https://xquik.com/api/v1/webhooks/telegram
Free. Connecting a chat and its messages cost no credits.
How it works
- Call this endpoint. It returns a
urllikehttps://t.me/XquikBot?start=.... - Open the link on a phone or computer with Telegram, then press Start.
- @XquikBot answers “Connected.” Each alert then arrives as a message. It shows the account and the event in bold. It also shows the post’s text or the profile change, and a link.
- Alerts that wait together come as 1 digest.
- A busy chat gets 5 quick messages, then 1 every 30 seconds. A quiet chat gets each alert at once.
- Only the first message of a minute rings. The rest arrive silently.
- A post that is new and has media is 1 alert. Its title is “New post with media”.
- 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
/stopto pause alerts and/statusto check them. A new link turns them on again. - Telegram can ask Xquik to slow down. When it does, the retry waits as long as it asks.
- @XquikBot works in private chats. It answers in English, Spanish, Turkish, Japanese, Korean or Chinese, by your Telegram language. Other languages get English.
Body
Headers
Response
201 Created
400 Invalid input
{ "error": "invalid_input", "message": "Pick at least 1 valid event type, like tweet.new." }
An event type is unknown. Use the types the monitor endpoints list.401 Unauthenticated
Missing or invalid API key. Check thex-api-key header value.503 Telegram unavailable
Telegram delivery is off for now. Try again later.Related. Webhooks overview · List webhooks · Webhook deliveries
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 } - 503
{ "error": "telegram_unavailable", "message": "Telegram alerts are off right now. Try again later." }