---
title: tickscript.defineCheck() function
description: tickscript.defineCheck() creates custom check data required by alert() and deadman().
url: https://docs.influxdata.com/flux/v0/stdlib/contrib/bonitoo-io/tickscript/definecheck/
estimated_tokens: 247
product: Flux
version: v0
publisher: InfluxData
canonical: https://docs.influxdata.com/flux/v0/stdlib/contrib/bonitoo-io/tickscript/definecheck/
date: '2024-04-08T16:01:02-06:00'
lastmod: '2024-04-08T16:01:02-06:00'
---

* Flux 0.111.0+

InfluxDB support

> [!Important]
> `tickscript.defineCheck()` is a user-contributed function maintained by
> the [package author](#package-author-and-maintainer).

`tickscript.defineCheck()` creates custom check data required by `alert()` and `deadman()`.

##### Function type signature

```js
(id: A, name: B, ?type: C) => {tags: {}, _type: C, _check_name: B, _check_id: A}
```

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

## Parameters

### id

(Required)
InfluxDB check ID.

### name

(Required)
InfluxDB check name.

### type

InfluxDB check type. Default is `custom`.

**Valid values**:

* `threshold`-`deadman`-`custom`

## Examples

### Generate InfluxDB check data

```
import "contrib/bonitoo-io/tickscript"

tickscript.defineCheck(id: "000000000000", name: "Example check name")// Returns:
// {
//     _check_id: 000000000000,
//     _check_name: Example check name,
//     _type: custom,
//     tags: {}
// }

```