Webhooks

Returns a t.me link to @XquikBot that connects a Telegram chat to the account's monitor events. Opening it & pressing Start connects the chat, which then gets each alert as a message. Alerts that wait together come as 1 digest. A busy chat gets 5 quick messages, then 1 every 30 s. Only 1 message a minute rings. The link works once, within 15 minutes. The chat appears in the webhook list with the URL telegram:<chat ID>, with deliveries, retries & resume as any webhook. In the chat, /stop pauses its alerts. It costs no credits.

post/api/v1/webhooks/telegram

Request

  • Base URL: https://xquik.com
  • URL: https://xquik.com/api/v1/webhooks/telegram
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

eventTypesEventType[]

Array of event types to subscribe to.

Example request

{
  "eventTypes": [
    "tweet.new",
    "tweet.reply"
  ]
}

Response

Telegram link created

urlstring uri required

Opens @XquikBot with the link's code.

expiresAtstring date-time required

When the link stops working, 15 minutes after creation.

Example response

{
  "url": "https://t.me/XquikBot?start=Q2hhdExpbmtDb2RlRXhhbXBsZTAx",
  "expiresAt": "2025-01-15T12:15:00.000Z"
}

Changes