Mavenoid help center

Mavenoid help center

  • Admin
  • Flows
  • Agent dashboard

›Reference

Get started

  • Intro to flows
  • Tutorial - Create a flow for live support
  • Tutorial - Create a flow for troubleshooting
  • Tutorial - Create a flow for FAQs

Learn more

  • Understand the types of nodes
  • Working with symptoms and solutions
  • Working with backtracks and choice lists
  • Understand potential solutions
  • Understand escalation
  • Understand search
  • Understand step-by-step guides
  • Understand canvas notes
  • Understand form data
  • Understand markup
  • Understand secrets
  • Understand flow components
  • Understand conditions
  • Understand translations
  • Understand flow feedback
  • Best practices for writing flows

How-to guides

  • Preview nodes and flows
  • Embed images and files
  • Embed videos
  • Receive conversation transcript emails
  • Set a flow image
  • Work with step-by-step guides
  • Add canvas notes
  • Copy and paste nodes
  • Create and embed flow components
  • Work with conditions
  • Configure flow feedback
  • View and manage flow feedback
  • Export, import, and copy flows
  • Set flow visibility
  • Manage translations
  • Create a live support node
  • Create an external API node
  • Start the user on different nodes based on the embedding page
  • Dynamically populate a choice list

Reference

  • Text formatting
  • Live support settings
  • Actions settings
  • External API settings
  • Form field types
  • Reserved form data
  • Markup expressions and operators
  • Supported languages
  • Glossary of terms

Form field types

Forms can be added to question or message nodes to prompt the user to manually enter information. This information will then be available within the flow as form data.

Forms have several different types of fields with different behavior depending on the kind of information the user is providing.

Text field

A text field that accepts arbitrary text.

Form with a text field

Validation can be performed with simple minimum and maximum length requirements or with regular expressions. Invalid data will prevent the user from proceeding to the next node.

Values are stored as text strings. Numeric values can also be treated as numbers and be used with math operations in markup.

Customer email

A text field that only accepts an email address.

Form with a customer email field

This is similar to the text field with two main differences:

  • The field is automatically subject to validation that only accepts well-formed email address strings. This does not mean the email address itself actually exists or that it belongs to the user.
  • The field is automatically associated with the reserved form data key $customer-email.

Values are stored as text strings.

Checkbox

A checkbox that the user can check or leave empty.

Form with a checkbox field

If a checkbox field is marked "Required", the user will not be allowed to submit the form until the box is checked. This can be useful for cases like ensuring the user accepts terms and conditions before proceeding.

Values are stored as true if the box is checked or false if it is not.

Description

A non-editable text snippet that can provide more information to the user.

Form with a description above a checkbox field

No values are stored from descriptions.

Date field

A date picker.

Form with a date field

Values are stored as strings with the format YYYY-MM-DD. For example, the date January 31, 2000, would be stored as "2000-01-31".

Choice list

A dropdown menu from which the user can select an option.

Form with a choice list field

Any number of options can be presented to the user. Each option has a value, which is what will be stored as form data, and can also have a label, which if specified will be displayed to the user instead of the value. Options are formatted as value if there is no label, or value[label] if there is one.

For example, you could specify a set of options as follows:

Swedish
American English[English (US)]
British English[English (UK)]

These would display to the user like this:

Swedish
English (US)
English (UK)

But if the user picked the option labeled "English (US)", the stored value would instead be "American English".

It is also possible to use form data to generate a list of options dynamically. For example, if you have a list of products in form data, you can present those products as options for the user to choose from by using markup.

Values are stored as text strings. Numeric values can also be treated as numbers and be used with math operations in markup.

Image/video upload

A file chooser allowing the user to upload one or more image or video files.

Form with an image/video upload field

The files are uploaded to Mavenoid's servers and can be accessed at corresponding URLs.

The maximum uploadable file size is 500 MB.

Values are stored as arrays of maps. Each map has three keys, "fileUrl", which has a value of a text string containing the file's URL on Mavenoid's servers, "fileType", which has a value of a text string containing the file's media type, and "fileName", which has a value of a text string containing the file's original name.

For example, if the user uploaded two files, screenshot.png and screencapture.mp4, the resulting form data value would look something like this:

[
  {
    "fileUrl":"https://mavenoidfiles.com/12345678abcdefgh12345678",
    "fileType":"image/png",
    "fileName":"screenshot.png"
  },
  {
    "fileUrl":"https://mavenoidfiles.com/ijklmnop12345678ijklmnop",
    "fileType":"video/mp4",
    "fileName":"screencapture.mp4"
  }
]

File upload

A file chooser allowing the user to upload one or more files.

Form with a file upload field

The files are uploaded to Mavenoid's servers and can be accessed at corresponding URLs.

The maximum uploadable file size is 500 MB.

Values are stored as arrays of maps. Each map has three keys, "fileUrl", which has a value of a text string containing the file's URL on Mavenoid's servers, "fileType", which has a value of a text string containing the file's media type, and "fileName", which has a value of a text string containing the file's original name.

For example, if the user uploaded the file receipt.pdf, the resulting form data value would look something like this:

[
  {
    "fileUrl":"https://mavenoidfiles.com/98765432abcdefgh98765432",
    "fileType":"application/pdf",
    "fileName":"receipt.pdf"
  }
]

Link

A non-editable link that the user can tap or click to visit the specified URL.

Form with a link above a text field

If a link field is marked "Required", the user will not be allowed to submit the form until the link has been opened. This can be useful for cases like ensuring the user views terms and conditions before proceeding.

No values are stored from links.

Last updated on 1/17/2023
← External API settingsReserved form data →
  • Text field
  • Customer email
  • Checkbox
  • Description
  • Date field
  • Choice list
  • Image/video upload
  • File upload
  • Link
Help center
AdminFlowsAgent dashboard
Product
Self-serviceLive supportWhy Mavenoid?PricingGet a demoTry it free
Learn
Customer storiesBlogWebinarsHelp centerROI calculator
Company
About usCareersPressContact us
© Mavenoid AB 2023 • Privacy policy