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

# IAlertingDialogContextValue

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

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Sub-context for the alerting create/edit dialog.

The connector hydrates this from dashboard state and provides the CRUD callbacks; the dialog and its hooks read it instead of reaching into the dashboard store. That direction is enforced by the `no-model-imports-in-clean-alerting` rule in `.dependency-cruiser.js`.

**Signature:**

```typescript
export interface IAlertingDialogContextValue 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [alertToEdit?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluealerttoedit) |  | [IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md) | **_(BETA)_** _(Optional)_ The alert being edited; undefined when creating a new one. |
| [commonDateFilterId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluecommondatefilterid) |  | string | **_(BETA)_** _(Optional)_ Local identifier of the dashboard's common (dashboard-level) date filter, when the automation-available filters include one. |
| [dashboardEvaluationFrequency?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluedashboardevaluationfrequency) |  | string | **_(BETA)_** _(Optional)_ The dashboard's configured evaluation frequency (cron expression); seeds the new alert's trigger interval when set. |
| [dashboardFilters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluedashboardfilters) |  | [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[] | **_(BETA)_** The dashboard's applied filters available to the alert — cross-filtering, hidden, and empty filters excluded. |
| [dashboardId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluedashboardid) |  | string | **_(BETA)_** _(Optional)_ Id of the dashboard the alert belongs to. |
| [dashboardParameters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluedashboardparameters) |  | [IDashboardParameter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardparameter/index.md)[] | **_(BETA)_** Effective dashboard parameters for the dialog's widget — the owning tab's parameters with any runtime override folded in (replaces the direct selectEffectiveDashboardParametersForWidget read in useAutomationAlertParameters). |
| [executionResultByRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvalueexecutionresultbyref) |  | (ref: [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) \| undefined) => { executionResult?: [IExecutionResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexecutionresult/index.md); } \| undefined | **_(BETA)_** Looks up a widget's execution result by ref; used to resolve attribute values for the condition's "for" field. |
| [hiddenFilters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluehiddenfilters) |  | [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[] | **_(BETA)_** Raw dashboard hidden filters (`selectDashboardHiddenFilters`); combined with the edited filters via `getAppliedWidgetFilters` inside the dialog. |
| [insight?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvalueinsight) |  | [IInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsight/index.md) | **_(BETA)_** _(Optional)_ Insight of [IAlertingDialogContextValue.widget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluewidget); undefined when alerting for a dashboard. |
| [isLoading](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvalueisloading) |  | boolean | **_(BETA)_** True while the dialog's initial data (automations) is still loading. |
| [mode](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluemode) |  | "create" \| "edit" | **_(BETA)_** Whether the dialog creates a new alert or edits an existing one. |
| [notificationChannels](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluenotificationchannels) |  | [INotificationChannelIdentifier](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inotificationchannelidentifier/index.md)[] \| [INotificationChannelMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inotificationchannelmetadataobject/index.md)[] | **_(BETA)_** Notification channels available as alert destinations. |
| [parameterValues](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvalueparametervalues) |  | [IInsightParameterValue](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsightparametervalue/index.md)[] | **_(BETA)_** Effective widget parameter values for the dialog's widget (replaces direct selectEffectiveParameterValuesForWidget read) |
| [widget?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluewidget) |  | [IWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidget/index.md) | **_(BETA)_** _(Optional)_ Widget the alert targets; undefined when alerting for a dashboard rather than a widget. |
| [widgetTitle?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluewidgettitle) |  | string | **_(BETA)_** _(Optional)_ Title of [IAlertingDialogContextValue.widget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluewidget); undefined when alerting for a dashboard. |

## Methods

| Method | Description |
| --- | --- |
| [createAlert(alert)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluecreatealert) | **_(BETA)_** Creates a new alert on the backend. |
| [deleteAlert(alert)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluedeletealert) | **_(BETA)_** Deletes the alert from the backend. |
| [saveAlert(alert)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluesavealert) | **_(BETA)_** Saves changes to an existing alert on the backend. |

## Property details

### IAlertingDialogContextValue.alertToEdit

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

The alert being edited; undefined when creating a new one.

**Signature:**

```typescript
alertToEdit?: IAutomationMetadataObject;
```

### IAlertingDialogContextValue.commonDateFilterId

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Local identifier of the dashboard's common (dashboard-level) date filter, when the automation-available filters include one.

**Signature:**

```typescript
commonDateFilterId?: string;
```

### IAlertingDialogContextValue.dashboardEvaluationFrequency

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

The dashboard's configured evaluation frequency (cron expression); seeds the new alert's trigger interval when set.

**Signature:**

```typescript
dashboardEvaluationFrequency?: string;
```

### IAlertingDialogContextValue.dashboardFilters

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

The dashboard's applied filters available to the alert — cross-filtering, hidden, and empty filters excluded.

**Signature:**

```typescript
dashboardFilters: FilterContextItem[];
```

### IAlertingDialogContextValue.dashboardId

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Id of the dashboard the alert belongs to.

**Signature:**

```typescript
dashboardId?: string;
```

### IAlertingDialogContextValue.dashboardParameters

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Effective dashboard parameters for the dialog's widget — the owning tab's parameters with any runtime override folded in (replaces the direct selectEffectiveDashboardParametersForWidget read in useAutomationAlertParameters).

**Signature:**

```typescript
dashboardParameters: IDashboardParameter[];
```

### IAlertingDialogContextValue.executionResultByRef

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Looks up a widget's execution result by ref; used to resolve attribute values for the condition's "for" field.

**Signature:**

```typescript
executionResultByRef: (ref: ObjRef | undefined) => {
        executionResult?: IExecutionResult;
    } | undefined;
```

### IAlertingDialogContextValue.hiddenFilters

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Raw dashboard hidden filters (`selectDashboardHiddenFilters`); combined with the edited filters via `getAppliedWidgetFilters` inside the dialog.

**Signature:**

```typescript
hiddenFilters: FilterContextItem[];
```

### IAlertingDialogContextValue.insight

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Insight of [IAlertingDialogContextValue.widget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluewidget); undefined when alerting for a dashboard.

**Signature:**

```typescript
insight?: IInsight;
```

### IAlertingDialogContextValue.isLoading

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

True while the dialog's initial data (automations) is still loading.

**Signature:**

```typescript
isLoading: boolean;
```

### IAlertingDialogContextValue.mode

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Whether the dialog creates a new alert or edits an existing one.

**Signature:**

```typescript
mode: "create" | "edit";
```

### IAlertingDialogContextValue.notificationChannels

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Notification channels available as alert destinations.

**Signature:**

```typescript
notificationChannels: INotificationChannelIdentifier[] | INotificationChannelMetadataObject[];
```

### IAlertingDialogContextValue.parameterValues

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Effective widget parameter values for the dialog's widget (replaces direct selectEffectiveParameterValuesForWidget read)

**Signature:**

```typescript
parameterValues: IInsightParameterValue[];
```

### IAlertingDialogContextValue.widget

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Widget the alert targets; undefined when alerting for a dashboard rather than a widget.

**Signature:**

```typescript
widget?: IWidget;
```

### IAlertingDialogContextValue.widgetTitle

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Title of [IAlertingDialogContextValue.widget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ialertingdialogcontextvalue/index.md#ialertingdialogcontextvaluewidget); undefined when alerting for a dashboard.

**Signature:**

```typescript
widgetTitle?: string;
```

## Method details

### IAlertingDialogContextValue.createAlert()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Creates a new alert on the backend.

**Signature:**

```typescript
createAlert(alert: IAutomationMetadataObjectDefinition): Promise<IAutomationMetadataObject>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| alert | [IAutomationMetadataObjectDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectdefinition/index.md) |  |

**Returns:**

Promise&lt;[IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md)&gt;

### IAlertingDialogContextValue.deleteAlert()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Deletes the alert from the backend.

**Signature:**

```typescript
deleteAlert(alert: IAutomationMetadataObject): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| alert | [IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md) |  |

**Returns:**

Promise&lt;void&gt;

### IAlertingDialogContextValue.saveAlert()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Saves changes to an existing alert on the backend.

**Signature:**

```typescript
saveAlert(alert: IAutomationMetadataObject): Promise<IAutomationMetadataObject>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| alert | [IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md) |  |

**Returns:**

Promise&lt;[IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md)&gt;