telegram.endpoint() function

telegram.endpoint() is a user-contributed function maintained by the package author and can be updated or removed at any time.

telegram.endpoint() sends a message to a Telegram channel using data from table rows.


telegram.endpoint is a factory function that outputs another function. The output function requires a mapFn parameter.


A function that builds the object used to generate the POST request. Requires an r parameter.

mapFn accepts a table row (r) and returns an object that must include the following fields:

  • channel
  • text
  • silent

For more information, see telegram.message() parameters.

The returned factory function accepts a mapFn parameter. The mapFn must return an record with the following properties:

  • channel
  • text
  • silent

See telegram.message parameters for more information.

Function type signature
    token: string,
    ?disableWebPagePreview: A,
    ?parseMode: B,
    ?url: string,
) => (
    mapFn: (r: C) => {D with text: G, silent: F, channel: E},
) => (<-tables: stream[C]) => stream[{C with _sent: string}]
For more information, see Function type signatures.



URL of the Telegram bot endpoint. Default is


(Required) Telegram bot token.


Parse mode of the message text. Default is MarkdownV2.


Disable preview of web links in the sent message. Default is false.


Send critical statuses to a Telegram channel

import "influxdata/influxdb/secrets"
import "contrib/sranka/telegram"

token = secrets.get(key: "TELEGRAM_TOKEN")
endpoint = telegram.endpoint(token: token)

crit_statuses =
    from(bucket: "example-bucket")
        |> range(start: -1m)
        |> filter(fn: (r) => r._measurement == "statuses" and status == "crit")

    |> endpoint(mapFn: (r) => ({channel: "-12345", text: "Disk usage is **${r.status}**.", silent: true}))()

Was this page helpful?

Thank you for your feedback!

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.