Add option fields to connector cards

Define the options of your connector cards in the Connector Builder Options dialog.

To access the Options dialog, click Add Options, either on a connector action card that begins a flow, or on the Return Outputs card that ends the flow.

To access the dialog again after you add fields to it, click Edit on the link that appears in the section header of the card.

When you add an options dropdown field to a card with a default value, the card saves those selected default options. After you deploy the connector project and add the card to a flow, the card shows the input and output fields based on those selections.

For cards built in Connector Builder, the options fields are collapsed when you add the card to a flow. To access the options dropdown menu to change a selection, you need to open the card's Options menu.

To add input and output fields, see Add input and output fields to connector cards.

Options fields
Add helper flows to populate a dynamic dropdown

Options fields

Options fields on a card are design-time inputs that a user selects when creating their flows. The values passed into the fields are static, meaning that they're the same with each flow execution. For example, the Custom API Action card has Request Type as a single field in the Options section. The end user selects the value when first adding the card to a flow. Whenever the card executes, the selected request method is performed against the given resource.

To add fields to a card:

Click Action.
On the connector action card, click Add Options.
In the dialog, click Add Field.

Field	Definition	Type
Group Name	By default, the Options group name appears as the section title for any fields added to this section of the card. You can't edit the Options group name.	Text
Label	Display name for the field that appears above the value on the card. The label can contain letters, numbers, hyphens, underscores, and spaces only. Leading or trailing spaces are prohibited.	Text
Field Type	Field type describes the type of field exposed to the card user. Options fields support the following data types: Text Field: Any static string value. Dropdown: A list of items chosen by the card user.	Dropdown
Data Type	Type of data that's passed to Connector Builder flows. Text is the only available type for Options.	Dropdown
Required	Indicates that a field is required during card setup. Defaults to True.	True/False
Dropdown values	Static Values: This option allows you to create a dropdown menu for a card user by manually populating the Display and Value fields. The display and value fields might be the same, as is the case for Custom API Action cards, but they may also be different. The Value is what is passed to the flow. Helper Flow: This option allows you to choose a flow that returns the dropdown values. Use this option if you need to collect a list from a service and that list can differ depending on the account.	Dropdown

Add helper flows to populate a dynamic dropdown

Builders can use helper flows to populate an Options dropdown when an HTTP call is needed to retrieve a list of items. Flows that return a list of dropdown items should return an object similar to the following example:

Copy

[
   {
      "value":"English",
      "key":"en_us"
   },
   {
      "value":"Chinese (Simplified)",
      "key":"zh_CN"
   },
   {
      "value":"Danish",
      "key":"da"
   }
]

See Add a dynamic dropdown field: HTTP example.

Add option fields to connector cards

Options fields

Add helper flows to populate a dynamic dropdown

Related topics