Interface: WorkflowButton
Description
Allows users to run a link trigger with customizable inputs.
See
Workflow button element reference.
Extends
Properties
accessibility_label?
optional accessibility_label: string;
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.
Defined in
block-kit/block-elements.ts:681
confirm?
optional confirm: ConfirmationDialog;
Description
A Confirm object that defines an optional confirmation dialog after the element is interacted with.
Inherited from
Defined in
style?
optional style: ColorScheme;
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.
Defined in
block-kit/block-elements.ts:676
text
text: PlainTextElement;
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.
Defined in
block-kit/block-elements.ts:636
type
type: "workflow_button";
Description
The type of element. In this case type is always workflow_button.
Defined in
block-kit/block-elements.ts:631
workflow
workflow: object;
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.