Preview dialogs in Connector Builder

When you customize fields in Connector Builder, the Preview pane displays how the fields appear on your connection dialog or action card before you deploy it.

Authentication

For authentication, the Preview window displays the following fields by default:

Authentication Type Fields

Basic

  • Name

  • Description

  • Username

  • Password

OAuth 2.0 with Authentication Code grant type

General tab:

  • Name

  • Description

Permissions tab:

  • Scope

OAuth 2.0 with Client Credentials grant type

  • Name

  • Description

  • Client ID

  • Client Secret

Custom

  • Name

  • Description

As you add fields in the Parameters, Config Values, or Scopes sections, the Preview window automatically displays the changed labels and input fields.

Notes for authentication

  • Any scope marked as Required appears in the preview with the checkbox disabled. This indicates that the end user can't remove the scope from the connection.

  • If you call a helper flow to generate fields in the Config Values section, the fields themselves don't appear. The preview only shows a static Dynamically generated label.

  • If the Visible toggle is turned off for a field in Config Values, the preview doesn't display that field.

  • If fields are removed from the Parameters, Config Values, or Scopes sections, those fields disappear from the preview.

  • You can't edit any of the fields directly in the Preview window.

Flow options, input, and output fields

When you create an action card or webhook event in Connector Builder, you can use the Preview window to see how the card appears to your end users.

As you add fields in the Options, Inputs, or Outputs dialogs, the field labels and text boxes automatically update in the Preview window. The field has a blank label until you add a string value.

Notes

  • If you change the type for a field to Dropdown, the Preview window shows the change and adds the default string Choose an option....

  • If the Required toggle is turned on for an option or input field, the field displays a red asterisk.

  • When you add dynamic inputs, a single text field is displayed under the group name Dynamic Fields.

  • Static and dynamic dropdown fields aren't shown in the Preview window.

  • If enough fields are added to the card to require a scroll bar, the scroll bar is shown.

  • If a field depends on another field, the Preview window shows it as disabled.

  • You can't edit any of the fields directly in the Preview window.

Validation of field names for preview

Validation rules prevent the use of prohibited characters in field names.

While the Preview window does display field names that use invalid characters, you can't save your configuration until you address the errors. For example, if you enter Domain$ in the Authentication dialog, or Input*_$ as a label for an Input field.

See Deployment validation errors.

Related topics

Create and edit connector settings

Build basic authentication

Build OAuth 2.0 authentication

Build custom authentication