Skip to main content

Dispatch action configuration object

Welcome to the new home of Slack developer docs!

We're still building and not all features are available quite yet. Enjoy this peek into the future!

Not ready for the future? Return to the past at api.slack.com.

Defines when a plain-text input element will return a block_actions interaction payload.

Fields​

FieldTypeDescriptionRequired?
trigger_actions_onString[]An array of interaction types that you would like to receive a block_actions payload for. Should be one or both of:on_enter_pressed — payload is dispatched when user presses the enter key while the input is in focus. Hint text will appear underneath the input explaining to the user to press enter to submit.on_character_entered — payload is dispatched when a character is entered (or removed) in the input.Optional

Example​

{
    "type": "input",
    "dispatch_action": true,
    "element": {
        "type": "plain_text_input",
        "multiline": true,
        "dispatch_action_config": {
            "trigger_actions_on": [
                "on_character_entered"
            ]
        }
    },
    "label": {
        "type": "plain_text",
        "text": "This is a multiline plain-text input",
        "emoji": true
    }
}