---
title: "POST /api/v1/webhooks/telegram"
method: POST
path: "/api/v1/webhooks/telegram"
tags: ["Webhooks"]
---

# POST /api/v1/webhooks/telegram

`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

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.

## Request body

- object
  - `eventTypes` EventType[]: Array of event types to subscribe to.

## Response `201`

Telegram link created

- object
  - `url` string, uri, required: Opens @XquikBot with the link's code.
  - `expiresAt` string, date-time, required: When the link stops working, 15 minutes after creation.

## Other responses

- `400`: Invalid input. A value past its maxLength gets this answer, & the message names the field & its limit.
- `401`: Unauthenticated
- `429`: Too many requests right now. Each user gets 500 reads a second. Each minute allows 120 writes & 60 deletes. `x_api_rate_limited` means X limits this read for now. Neither answer costs anything. Wait for the seconds in `Retry-After`, then retry.
- `500`: Unexpected error.
- `503`: Telegram delivery is off for now.
- `default`: Unexpected error.

## Changes

- **2026-10-20** `45942c75fdc2`: 12 warning
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #2: StructuredError]/code` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `400`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `401`
  - …8 more

[Operation history](https://skmtc.dev/xquik-dev/apis/xquik-api/changes/api/v1/webhooks/telegram/post.md)

---

[API](https://skmtc.dev/xquik-dev/apis/xquik-api.md) · [All operations](https://skmtc.dev/xquik-dev/apis/xquik-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xquik-dev/apis/xquik-api/revisions/45942c75fdc2?raw)