> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IWidgetAlertBase

- Package: [@gooddata/sdk-model](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-model/src/dashboard/alert.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Common widget alert properties

**Signature:**

```typescript
export interface IWidgetAlertBase 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidgetalertbase/index.md#iwidgetalertbasedashboard) | `readonly` | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | **_(ALPHA)_** KPI can be on more dashboards - we need to distinguish which dashboard can be used as link in dashboard alerting email |
| [description](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidgetalertbase/index.md#iwidgetalertbasedescription) | `readonly` | string | **_(ALPHA)_** Kpi alert description |
| [isTriggered](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidgetalertbase/index.md#iwidgetalertbaseistriggered) | `readonly` | boolean | **_(ALPHA)_** Is alert triggered? |
| [threshold](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidgetalertbase/index.md#iwidgetalertbasethreshold) | `readonly` | number | **_(ALPHA)_** Threshold |
| [title](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidgetalertbase/index.md#iwidgetalertbasetitle) | `readonly` | string | **_(ALPHA)_** Kpi alert title |
| [whenTriggered](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidgetalertbase/index.md#iwidgetalertbasewhentriggered) | `readonly` | "underThreshold" \| "aboveThreshold" | **_(ALPHA)_** Rule to apply |
| [widget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidgetalertbase/index.md#iwidgetalertbasewidget) | `readonly` | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | **_(ALPHA)_** Kpi ref (currently only kpi widget alerts are supported) |

## Property details

### IWidgetAlertBase.dashboard

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

KPI can be on more dashboards - we need to distinguish which dashboard can be used as link in dashboard alerting email

**Signature:**

```typescript
readonly dashboard: ObjRef;
```

### IWidgetAlertBase.description

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Kpi alert description

**Signature:**

```typescript
readonly description: string;
```

### IWidgetAlertBase.isTriggered

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Is alert triggered?

**Signature:**

```typescript
readonly isTriggered: boolean;
```

### IWidgetAlertBase.threshold

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Threshold

**Signature:**

```typescript
readonly threshold: number;
```

### IWidgetAlertBase.title

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Kpi alert title

**Signature:**

```typescript
readonly title: string;
```

### IWidgetAlertBase.whenTriggered

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Rule to apply

**Signature:**

```typescript
readonly whenTriggered: "underThreshold" | "aboveThreshold";
```

### IWidgetAlertBase.widget

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Kpi ref (currently only kpi widget alerts are supported)

**Signature:**

```typescript
readonly widget: ObjRef;
```