WorkflowStepView.md

@slack/web-api / WorkflowStepView

Interface: WorkflowStepView

Defined in: node_modules/@slack/types/dist/views.d.ts:61

Configuration modal for legacy Workflow Steps from Apps.

Deprecated

Steps from Apps are deprecated and will no longer be executed starting September 12, 2024. For more information, see our deprecation announcement.

Extends

• BaseView

Properties

blocks

blocks: AnyBlock[];

Defined in: node_modules/@slack/types/dist/views.d.ts:5

Description

An array of AnyBlock that defines the content of the view. Max of 100 blocks.

Inherited from

BaseView.blocks

---

callback_id?

optional callback_id: string;

Defined in: node_modules/@slack/types/dist/views.d.ts:18

Description

An identifier to recognize interactions and submissions of this particular view. Don't use this to store sensitive information (use private_metadata instead). Maximum length of 255 characters.

See

Handling and responding to interactions.

Inherited from

BaseView.callback_id

---

external_id?

optional external_id: string;

Defined in: node_modules/@slack/types/dist/views.d.ts:20

Description

A custom identifier that must be unique for all views on a per-team basis.

Inherited from

BaseView.external_id

---

private_metadata?

optional private_metadata: string;

Defined in: node_modules/@slack/types/dist/views.d.ts:12

Description

String that will be sent to your app in `view_submission` and `block_actions` events. Maximum length of 3000 characters.

Inherited from

BaseView.private_metadata

---

submit_disabled?

optional submit_disabled: boolean;

Defined in: node_modules/@slack/types/dist/views.d.ts:67

Description

When set to true, disables the submit button until the user has completed one or more inputs. Defaults to false.

---

type

type: "workflow_step";

Defined in: node_modules/@slack/types/dist/views.d.ts:62