---
title: opsgenie.endpoint() function
description: >
  The `opsgenie.endpoint()` function sends an alert message to Opsgenie using data from table rows.
aliases:
  - /influxdb/v2.0/reference/flux/stdlib/contrib/opsgenie/endpoint/
  - /influxdb/cloud/reference/flux/stdlib/contrib/opsgenie/endpoint/
menu:
  flux_0_x_ref:
    name: opsgenie.endpoint
    parent: opsgenie
weight: 301
flux/v0.x/tags: [notification endpoints]
introduced: 0.84.0
---

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

```js
import "contrib/sranka/opsgenie"

opsgenie.endpoint(
    url: "https://api.opsgenie.com/v2/alerts",
    apiKey: "YoUrSup3R5ecR37AuThK3y",
    entity: "example-entity",
)
```

## Parameters

### url {data-type="string"}
Opsgenie API URL.
Defaults to `https://api.opsgenie.com/v2/alerts`.

### apiKey {data-type="string"}
({{< req >}})
Opsgenie API authorization key.

### entity {data-type="string"}
Alert entity used to specify the alert domain.

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

### mapFn {data-type="function"}
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()`](/flux/v0.x/stdlib/contrib/sranka/opsgenie/sendalert/)._

## Examples

##### Send critical statuses to Opsgenie
```js
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")

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