Skip to content

WorkflowButton.md

Latest commit

 

History

History
145 lines (87 loc) · 3.16 KB

WorkflowButton.md

File metadata and controls

145 lines (87 loc) · 3.16 KB

@slack/web-api / WorkflowButton

Interface: WorkflowButton

Defined in: node_modules/@slack/types/dist/block-kit/block-elements.d.ts:542

Description

Allows users to run a link trigger with customizable inputs.

See

Workflow button element reference.

Extends

Properties

accessibility_label?

optional accessibility_label: string;

Defined in: node_modules/@slack/types/dist/block-kit/block-elements.d.ts:596

Description

A label for longer descriptive text about a button element. This label will be read out by screen readers instead of the button text object. Maximum length for this field is 75 characters.

confirm?

optional confirm: ConfirmationDialog;

Defined in: node_modules/@slack/types/dist/block-kit/extensions.d.ts:21

Description

A Confirm object that defines an optional confirmation dialog after the element is interacted with.

Inherited from

Confirmable.confirm

style?

optional style: ColorScheme;

Defined in: node_modules/@slack/types/dist/block-kit/block-elements.d.ts:591

Description

Decorates buttons with alternative visual color schemes. Use this option with restraint. primary gives buttons a green outline and text, ideal for affirmation or confirmation actions. primary should only be used for one button within a set. danger gives buttons a red outline and text, and should be used when the action is destructive. Use danger even more sparingly than primary. If you don't include this field, the default button style will be used.

text

text: PlainTextElement;

Defined in: node_modules/@slack/types/dist/block-kit/block-elements.d.ts:551

Description

A PlainTextElement that defines the button's text. text may truncate with ~30 characters. Maximum length for the text in this field is 75 characters.

type

type: "workflow_button";

Defined in: node_modules/@slack/types/dist/block-kit/block-elements.d.ts:546

Description

The type of element. In this case type is always workflow_button.

workflow

workflow: object;

Defined in: node_modules/@slack/types/dist/block-kit/block-elements.d.ts:555

trigger

trigger: object;
Description

Properties of the link trigger that will be invoked via this button.

trigger.customizable_input_parameters?
optional customizable_input_parameters: object[];
Description

List of customizable input parameters and their values. Should match input parameters specified on the provided trigger.

trigger.url
url: string;
Description

The trigger URL of the link trigger

Description

A workflow object that contains details about the workflow that will run when the button is clicked.