zenoss.endpoint() function

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

zenoss.endpoint() sends events to Zenoss using data from input rows.


zenoss.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:

  • summary
  • device
  • component
  • severity
  • eventClass
  • eventClassKey
  • collector
  • message

For more information, see zenoss.event() parameters.

Function type signature
    url: string,
    ?action: A,
    ?apiKey: B,
    ?method: C,
    ?password: string,
    ?tid: D,
    ?type: E,
    ?username: string,
) => (
    mapFn: (
        r: F,
    ) => {
        G with
        summary: O,
        severity: N,
        message: M,
        eventClassKey: L,
        eventClass: K,
        device: J,
        component: I,
        collector: H,
) => (<-tables: stream[F]) => stream[{F with _sent: string}] where B: Equatable
For more information, see Function type signatures.



(Required) Zenoss router endpoint URL.


Zenoss username to use for HTTP BASIC authentication. Default is "" (no authentication).


Zenoss password to use for HTTP BASIC authentication. Default is "" (no authentication).


Zenoss cloud API key. Default is "" (no API key).


Zenoss router name. Default is "EventsRouter".


EventsRouter method. Default is "add_event".


Event type. Default is "rpc".


Temporary request transaction ID. Default is 1.


Send critical events to Zenoss

import "contrib/bonitoo-io/zenoss"
import "influxdata/influxdb/secrets"

url = ""
username = secrets.get(key: "ZENOSS_USERNAME")
password = secrets.get(key: "ZENOSS_PASSWORD")
endpoint = zenoss.endpoint(url: url, username: username, password: password)

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

    |> endpoint(
        mapFn: (r) =>
                summary: "Critical event for ${}",
                device: r.deviceID,
                severity: "Critical",
                eventClass: "/App",
                eventClassKey: "",
                collector: "",
                message: "${} is in a critical state.",

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.