Documentation

telegram.endpoint() function

telegram.endpoint() is a user-contributed function maintained by the package author.

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

Usage

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

mapFn

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.

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.

Parameters

url

URL of the Telegram bot endpoint. Default is https://api.telegram.org/bot.

token

(Required) Telegram bot token.

parseMode

Parse mode of the message text. Default is MarkdownV2.

disableWebPagePreview

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

Examples

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")

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

Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB 3.0

The new core of InfluxDB built with Rust and Apache Arrow. Available today in InfluxDB Cloud Dedicated.

Learn more

State of the InfluxDB Cloud Serverless documentation

The new documentation for InfluxDB Cloud Serverless is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.