Documentation

webexteams.message() function

webexteams.message() is a user-contributed function maintained by the package author.

webexteams.message() sends a single message to Webex using the Webex messages API.

Function type signature
(
    markdown: A,
    roomId: B,
    text: C,
    token: string,
    ?url: string,
) => int

For more information, see Function type signatures.

Parameters

url

Base URL of Webex API endpoint (without a trailing slash). Default is https://webexapis.com.

token

(Required) Webex API access token.

roomId

(Required) Room ID to send the message to.

text

(Required) Plain text message.

markdown

(Required) Markdown formatted message.

Examples

Send the last reported status to Webex Teams

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

apiToken = secrets.get(key: "WEBEX_API_TOKEN")

lastReported =
    from(bucket: "example-bucket")
        |> range(start: -1m)
        |> filter(fn: (r) => r._measurement == "statuses")
        |> last()
        |> findRecord(fn: (key) => true, idx: 0)

webexteams.message(
    token: apiToken,
    roomId: "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
    text: "Disk usage is ${lastReported.status}.",
    markdown: "Disk usage is **${lastReported.status}**.",
)

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more