opsgenie.endpoint() function

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

opsgenie.endpoint() sends an alert message to Opsgenie using data from table rows.


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


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

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

  • message
  • alias
  • description
  • priority
  • responders
  • tags
  • actions
  • details
  • visibleTo

For more information, see opsgenie.sendAlert.

Function type signature
    apiKey: string,
    ?entity: string,
    ?url: string,
) => (
    mapFn: (
        r: A,
    ) => {
        B with
        visibleTo: [string],
        tags: E,
        responders: [string],
        priority: string,
        message: string,
        details: D,
        description: string,
        alias: string,
        actions: C,
) => (<-tables: stream[A]) => stream[{A with _sent: string}] where D: Stringable
For more information, see Function type signatures.



Opsgenie API URL. Defaults to


(Required) (Required) Opsgenie API authorization key.


Alert entity used to specify the alert domain.


Send critical statuses to Opsgenie

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

apiKey = secrets.get(key: "OPSGENIE_APIKEY")
endpoint = opsgenie.endpoint(apiKey: apiKey)

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

    |> endpoint(
        mapFn: (r) =>
                message: "Great Scott!- Disk usage is: ${r.status}.",
                alias: "disk-usage-${r.status}",
                description: "",
                priority: "P3",
                responders: ["", "team:itcrowd"],
                tags: [],
                entity: "my-lab",
                actions: [],
                details: "{}",
                visibleTo: [],

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.