Skip to main content

@slack/web-api / AlertBlock

Interface: AlertBlock

Defined in: packages/types/dist/block-kit/blocks.d.ts:51

Description​

A prominent notice block for displaying warnings, status updates, or other important information.

See​

Alert block reference.

Extends​

Properties​

block_id?​

optional block_id: string;

Defined in: packages/types/dist/block-kit/blocks.d.ts:15

Description​

A string acting as a unique identifier for a block. If not specified, a block_id will be generated. You can use this block_id when you receive an interaction payload to identify the source of the action. Maximum length for this field is 255 characters. block_id should be unique for each message and each iteration of a message. If a message is updated, use a new block_id.

Inherited from​

Block.block_id

level?​

optional level: "default" | "info" | "warning" | "error" | "success";

Defined in: packages/types/dist/block-kit/blocks.d.ts:63

Description​

The severity level of the alert. Defaults to "default" if omitted.

text​

text: TextObject;

Defined in: packages/types/dist/block-kit/blocks.d.ts:59

Description​

The alert message content in the form of a TextObject.

type​

type: "alert";

Defined in: packages/types/dist/block-kit/blocks.d.ts:55

Description​

The type of block. For an alert block, type is always alert.

Overrides​

Block.type