---
title: sensu.event() function
description: sensu.event() sends a single event to the Sensu Events API.
url: https://docs.influxdata.com/flux/v0/stdlib/contrib/sranka/sensu/event/
estimated_tokens: 2319
product: Flux
version: v0
---

# sensu.event() function

-   Flux 0.90.0+
-   View InfluxDB support

`sensu.event()` is a user-contributed function maintained by the [package author](#package-author-and-maintainer).

`sensu.event()` sends a single event to the [Sensu Events API](https://docs.sensu.io/sensu-go/latest/api/events/#create-a-new-event).

##### Function type signature

```js
(
    apiKey: string,
    checkName: string,
    text: A,
    url: string,
    ?entityName: string,
    ?handlers: B,
    ?namespace: string,
    ?state: string,
    ?status: C,
) => int where C: Equatable
```

For more information, see [Function type signatures](/flux/v0/function-type-signatures/).

## Parameters

### url

(Required) Base URL of [Sensu API](https://docs.sensu.io/sensu-go/latest/migrate/#architecture) without a trailing slash.

Example: `http://localhost:8080`

### apiKey

(Required) Sensu [API Key](https://docs.sensu.io/sensu-go/latest/operations/control-access/).

### checkName

(Required) Check name.

Use alphanumeric characters, underscores (`_`), periods (`.`), and hyphens (`-`). All other characters are replaced with an underscore.

### text

(Required) Event text.

Mapped to `output` in the Sensu Events API request.

### handlers

Sensu handlers to execute. Default is `[]`.

### status

Event status code that indicates [state](/flux/v0/stdlib/contrib/sranka/sensu/event/#state). Default is `0`.

| Status code | State |
| --- | --- |
| 0 | OK |
| 1 | WARNING |
| 2 | CRITICAL |
| Any other value | UNKNOWN or custom state |

### state

Event state. Default is `"passing"` for `0` [status](/flux/v0/stdlib/contrib/sranka/sensu/event/#status) and `"failing"` for other statuses.

**Accepted values**:

-   `"failing"`
-   `"passing"`
-   `"flapping"`

### namespace

[Sensu namespace](https://docs.sensu.io/sensu-go/latest/reference/rbac/). Default is `"default"`.

### entityName

Event source. Default is `influxdb`.

Use alphanumeric characters, underscores (`_`), periods (`.`), and hyphens (`-`). All other characters are replaced with an underscore.

## Examples

### Send the last reported status to Sensu

```js
import "influxdata/influxdb/secrets"
import "contrib/sranka/sensu"

apiKey = secrets.get(key: "SENSU_API_KEY")

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

sensu.event(
    url: "http://localhost:8080",
    apiKey: apiKey,
    checkName: "diskUsage",
    text: "Disk usage is **${lastReported.status}**.",
)
```

#### Related

-   [Sensu Events API](https://docs.sensu.io/sensu-go/latest/api/events/)
-   [Sensu APIKeys API](https://docs.sensu.io/sensu-go/latest/api/apikeys/)
-   [Sensu handlers](https://docs.sensu.io/sensu-go/latest/reference/handlers/)

[single notification](/flux/v0/tags/single-notification/)