BotFrame

Triggers · Workflow trigger

Modal submitted

The Modal submitted trigger as it appears in the workflow editor.

What starts it

Continue after a user submits a form.

When the selected Discord event happens, this trigger starts the workflow and makes User ID, User mention, Channel ID, Guild ID, Modal value available to connected nodes.

Typical use

Continue after a user submits the form identified by its custom ID.

How to use it

  1. Add it as the workflow startChoose Modal submitted when creating the workflow’s Discord event.
  2. Connect the workflow pathConnect its Flow output to the first node that should run.
  3. Choose settings and connect valuesSet Custom ID, Event value. Connections can also supply values produced by earlier nodes.

Settings

These are the options shown when you add this trigger. A connected value can replace a setting when the workflow runs.

SettingStarting valueWhat it controls
Custom IDsupport_modalMatches this workflow with the corresponding Discord button, menu, or form.
Event valuefield_valueChooses which detail from the Discord event is provided to the workflow.

Value connections

Value connections pass information between nodes without changing the order of the workflow. When an input is not connected, BotFrame uses the value selected in the node or details from the starting Discord event when available.

Inputs

This trigger gets its information from the Discord event that starts the workflow.

Outputs

User IDUser
Optional
User mentionUser
Optional
Channel IDChannel
Optional
Guild IDServer
Optional
Modal valueText
Optional

What happens when it runs

When the selected Discord event happens, this trigger starts the workflow and makes User ID, User mention, Channel ID, Guild ID, Modal value available to connected nodes.

You can use this item in a published BotFrame workflow. You can also test it in the simulator.

These details match the node currently available in the BotFrame workflow editor.