Show Modal

Show Modal

Pop up a form for the user to fill in

Note: Must be the first step (index 0) in its branch/trigger.

Fields

FieldTypeRequiredDescription
titlestringyesModal title.
fieldsarray of {customId, label, style?, required?, saveAs?}, non-emptyyescustomId must be unique within the step. style is 'SHORT' or 'PARAGRAPH'. Fields without saveAs are shown but their value is discarded.
timeoutMsnumbernoDefaults to 600,000ms.

Example

{
  "id": "01H8XGJVBWX7Y5Z3K9M2N4P6Q1",
  "type": "show_modal",
  "title": "Feedback",
  "fields": [
    {
      "customId": "comment",
      "label": "Your comment",
      "style": "PARAGRAPH",
      "required": true,
      "saveAs": {
        "scope": "run",
        "name": "comment"
      }
    }
  ]
}

Did this page help you?