Issue a one-time code that links a Telegram chat to this tenant

POST

/notifications/telegram/link

const url = 'https://api.flotera.com/api/v1/notifications/telegram/link';
const options = {
  method: 'POST',
  headers: {cookie: '__Host-erm_session=<__Host-erm_session>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.flotera.com/api/v1/notifications/telegram/link \
  --cookie __Host-erm_session=<__Host-erm_session>

Returns a short-lived code the owner sends to the bot. Whoever redeems the code receives the tenant’s whole alert stream, so the code is a bearer credential: it is stored only as a peppered hash, it is never logged, and it is issued to a signed-in session only. An API token is rejected with 403 on purpose — a token holder must not be able to redirect notifications. 503 means the bot is not configured, so a code would have nobody to redeem it.

Authorizations

sessionCookie

Responses

200

Code issued. This is the only place the plaintext exists.

application/json

A one-time link code. The plaintext exists only in this response — the server keeps a peppered hash. Ten body characters over a 32-symbol alphabet give 2^50 combinations; the bot stays silent on a wrong code so it cannot be used as a brute-force oracle.

object

code

required

Alphabet excludes I/O/0/1 — the code is read off a screen and dictated aloud.

string

/^ERM-[A-HJ-NP-Z2-9]{5}-[A-HJ-NP-Z2-9]{5}$/

expires_at

required

RFC 3339 UTC with microsecond precision.

string format: date-time

bot_username

required

Bot handle without @. Served by the API rather than baked into the panel bundle: staging and production use different bots.

string

deep_link

required

Opens the bot with the code already filled in.

string format: uri

Example

{
  "code": "ERM-K3M7Q-XB29T",
  "expires_at": "2026-07-25T10:15:30.123456Z",
  "bot_username": "ErmeonBot",
  "deep_link": "https://t.me/ErmeonBot?start=ERMK3M7QXB29T"
}

401

Missing/invalid credentials (code=unauthorized).

application/problem+json

RFC 9457 problem document with a stable machine code.

object

type

required

string format: uri

title

required

string

<= 256 characters

status

required

integer

>= 100 <= 599

code

required

Stable machine-readable error code (03 §2.4).

string

Allowed values: unauthorized forbidden csrf_rejected not_found conflict idempotency_conflict validation_failed rate_limited payload_too_large unsupported_agent_version temporarily_unavailable offline_queue_full online_queue_full plan_required server_limit_reached feature_not_entitled account_in_grace account_frozen payment_pending payment_expired payment_amount_mismatch change_already_pending change_already_applied change_effective reserve_not_covered direction_changed

detail

string

<= 2048 characters

instance

string

<= 512 characters

request_id

UUID (v7 for new entities; v4 accepted during migration).

string format: uuid

errors

Array<object>

<= 100 items

object

path

required

JSON Pointer to the offending field.

string

<= 512 characters

code

required

string

<= 64 characters

Example

{
  "type": "https://ermeon.com/problems/validation",
  "code": "unauthorized"
}

403

Authenticated but not permitted. code=forbidden — role/scope mismatch; code=feature_not_entitled — the plan does not include the capability; code=account_frozen — the account is frozen and this operation is declared x-ermeon-frozen: deny. The three are deliberately distinct: only the last one is fixed by a top-up (13 §5.6).

application/problem+json

RFC 9457 problem document with a stable machine code.

object

type

required

string format: uri

title

required

string

<= 256 characters

status

required

integer

>= 100 <= 599

code

required

Stable machine-readable error code (03 §2.4).

string

detail

string

<= 2048 characters

instance

string

<= 512 characters

request_id

UUID (v7 for new entities; v4 accepted during migration).

string format: uuid

errors

Array<object>

<= 100 items

object

path

required

JSON Pointer to the offending field.

string

<= 512 characters

code

required

string

<= 64 characters

Example

{
  "type": "https://ermeon.com/problems/validation",
  "code": "unauthorized"
}

429

Rate limit exceeded (code=rate_limited).

application/problem+json

RFC 9457 problem document with a stable machine code.

object

type

required

string format: uri

title

required

string

<= 256 characters

status

required

integer

>= 100 <= 599

code

required

Stable machine-readable error code (03 §2.4).

string

detail

string

<= 2048 characters

instance

string

<= 512 characters

request_id

UUID (v7 for new entities; v4 accepted during migration).

string format: uuid

errors

Array<object>

<= 100 items

object

path

required

JSON Pointer to the offending field.

string

<= 512 characters

code

required

string

<= 64 characters

Example

{
  "type": "https://ermeon.com/problems/validation",
  "code": "unauthorized"
}

Headers

Retry-After

integer

Seconds to wait before retrying.

503

A dependency the endpoint needs is not configured or is temporarily unavailable (code=unavailable). The rest of the API keeps working — an absent external integration must not take the service down.

application/problem+json

RFC 9457 problem document with a stable machine code.

object

type

required

string format: uri

title

required

string

<= 256 characters

status

required

integer

>= 100 <= 599

code

required

Stable machine-readable error code (03 §2.4).

string

detail

string

<= 2048 characters

instance

string

<= 512 characters

request_id

UUID (v7 for new entities; v4 accepted during migration).

string format: uuid

errors

Array<object>

<= 100 items

object

path

required

JSON Pointer to the offending field.

string

<= 512 characters

code

required

string

<= 64 characters

Example

{
  "type": "https://ermeon.com/problems/validation",
  "code": "unauthorized"
}