API reference · Alerts
Connect Telegram
Starts the Telegram flow by handing back a code and a link.
- Authentication
- Bearer token
- Retries
- Idempotency-Key
- Body
- None
- Version
- 2026-09-03
Telegram's constraint drives the shape: the customer must message the bot first, so the product cannot ask for an id it has no way to obtain. The code they send is what lets poll identify which chat is theirs.
Headers
Idempotency-KeystringA unique key of your choosing, so this request can be retried safely. The first request with a given key executes; every replay returns that first response unchanged, with
Idempotent-Replay: trueset.Generate one key per action, not per session - reusing a key with a different body is refused with 422 rather than silently replaying the wrong answer. Keys are remembered for 24 hours. A request that failed releases its key, so a retry after fixing the payload runs normally.
Up to 255 characters
Responses
- 200OKapplication/json
object
5 response headers
- RateLimit-Limit
Requests permitted in the current window.
- RateLimit-Remaining
Requests left in the current window. Back off before it reaches 0.
- RateLimit-Reset
Seconds until the current window resets.
- X-API-Version
The dated version of the API contract that served this response, e.g.
2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.- X-Request-ID
Quote this in a support request to identify the call.
Example request
curl -X POST "https://api.integrable.cloud/api/alerts/telegram/connect" \
-H "Authorization: Bearer $INTEGRABLE_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"Set INTEGRABLE_API_KEY first. The same call from the TypeScript or Python SDK takes the same fields.
Errors
Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:
unauthenticated· 401 — The request carried no API key, or one the API could not verify.forbidden· 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.idempotency_key_reused· 422 — This `Idempotency-Key` was used before, for a request with a different body.rate_limited· 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-bot limit on top.
More Alerts endpoints
- get/api/alertsList channels
- put/api/alertsSave channel
- post/api/alerts/estimateEstimate an alert's cost
- post/api/alerts/telegram/pollCheck the Telegram connection
- delete/api/alerts/{policy_id}Delete channel
- post/api/alerts/{policy_id}/testTest channel
- post/api/alerts/{policy_id}/verifyFinish verification
- post/api/alerts/{policy_id}/verify/startStart verification
Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.