# AlertDefinitionBase

Canonical page: https://www.adaptabletools.com/docs/reference/alertdefinitionbase

Fields every alert definition has.

`Name` identifies the alert. `MessageType` is required and sets the colour, icon and log level (`'Info'`, `'Success'`, `'Warning'` or `'Error'`). `MessageHeader` is the notification title. `MessageText` is the body. Suspend with `IsSuspended`.

```ts title="TypeScript"
export interface AlertDefinitionBase extends SuspendableObject 
```

###### Extends

[`SuspendableObject`](https://www.adaptabletools.com/docs/reference/suspendableobject.md)

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [MessageHeader](https://www.adaptabletools.com/docs/reference/alertdefinitionbase.md#messageheader) | `string` | Title of displayed Alert Message |
| [MessageText](https://www.adaptabletools.com/docs/reference/alertdefinitionbase.md#messagetext) | `string` | Body of the displayed alert. The title is .<br/><br/>Tokens such as the column and the old and new values are substituted when the alert fires. When omitted, a rule-based alert uses the scope and the rule, and a row-change alert uses a count of the rows that were added or removed. `alertOptions.alertMessageText` overrides this text when it returns a string. |
| [MessageType](https://www.adaptabletools.com/docs/reference/alertdefinitionbase.md#messagetype) | [`AdaptableMessageType`](https://www.adaptabletools.com/docs/reference/adaptablemessagetype.md) | Type of Alert: &#39;Info&#39;, &#39;Success&#39;, &#39;Warning&#39;, &#39;Error&#39;; influences Alert colour, icon and logging |
| [Name](https://www.adaptabletools.com/docs/reference/alertdefinitionbase.md#name) | `string` | Name of the Alert Definition |
| [Type](https://www.adaptabletools.com/docs/reference/alertdefinitionbase.md#type) | [`AlertType`](https://www.adaptabletools.com/docs/reference/alerttype.md) | Alert category. When omitted, inferred from `Rule` or `Schedule`. See . |
| [IsReadOnly](https://www.adaptabletools.com/docs/reference/alertdefinitionbase.md#isreadonly) | `boolean` | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of &#39;Full&#39;) |
| [IsSuspended](https://www.adaptabletools.com/docs/reference/alertdefinitionbase.md#issuspended) | `boolean` | Suspends (i.e. turns off) an Adaptable Object |

## Property Details

### MessageHeader

Title of displayed Alert Message

```ts title="TypeScript"
MessageHeader?: string;
```

###### Property Value

`string`

### MessageText

Body of the displayed alert. The title is .

Tokens such as the column and the old and new values are substituted when the alert fires. When omitted, a rule-based alert uses the scope and the rule, and a row-change alert uses a count of the rows that were added or removed. `alertOptions.alertMessageText` overrides this text when it returns a string.

```ts title="TypeScript"
MessageText?: string;
```

###### Property Value

`string`

### MessageType

Type of Alert: &#39;Info&#39;, &#39;Success&#39;, &#39;Warning&#39;, &#39;Error&#39;; influences Alert colour, icon and logging

```ts title="TypeScript"
MessageType: AdaptableMessageType;
```

###### Property Value

[`AdaptableMessageType`](https://www.adaptabletools.com/docs/reference/adaptablemessagetype.md)

### Name

Name of the Alert Definition

```ts title="TypeScript"
Name: string;
```

###### Property Value

`string`

### Type

Alert category. When omitted, inferred from `Rule` or `Schedule`. See .

```ts title="TypeScript"
Type?: AlertType;
```

###### Property Value

[`AlertType`](https://www.adaptabletools.com/docs/reference/alerttype.md)

### IsSuspended

> *Inherited from [SuspendableObject](https://www.adaptabletools.com/docs/reference/suspendableobject.md)*

Suspends (i.e. turns off) an Adaptable Object

```ts title="TypeScript"
IsSuspended?: boolean;
```

###### Property Value

`boolean`

### IsReadOnly

> *Inherited from [AdaptableObject](https://www.adaptabletools.com/docs/reference/adaptableobject.md)*

Sets Entity to ReadOnly (overwriting a Strategy Entitlement of &#39;Full&#39;)

```ts title="TypeScript"
IsReadOnly?: boolean;
```

###### Property Value

`boolean`