Skip to main content

Configuring fields

Overview

Use fields to store and manage content in Dopt. In this guide, we’ll walk through how to configure fields and how to update values attached to those fields.

Adding fields

Add a new field by selecting the component block for a given flow version in the context of an identified user.

For custom component blocks, click the Fields tab in the block panel and then click the Add field button. For all other component blocks, click the Config tab in the block panel and then click the Add custom field button.

info

Field identifiers cannot be updated after the field is created. Identifiers are also unique per component block so you can have the same identifier across component blocks.

Updating field configurations

Field configurations determine the shape of the field such as its type and default value. Configurations can only be updated while in the uncommitted version of a flow.

To update a field configuration, select the custom component block that contains the field you want to update. In the panel for the custom component block, click the Fields tab and then click the name of the field you want to configure.

Custom fields on non-custom components can be edited as normal in the Config tab. Non-custom components also come pre-configured with default fields which cannot be edited.

Updating and deploying field values

Field values are what determine the content that a field stores.

To update a field value, select the component block that contains the field you want to update the value for. In the panel for the component block, click the Fields tab for custom component blocks or the Config tab for all other component blocks and then click the value of the field you want to update.

info

Each flow version stores its own collection of field values so they may differ between versions.

Once you are statisfied with the content changes you have made, you can click the Deploy changes button in the flow header to push your changes live for the flow version you are on.

info

Deploying changes is only necessary for numbered versions of a flow. Field value changes in the uncommitted version will be reflected immediately without the need to deploy the changes made.

Deleting fields

Similar to updating configurations, fields can only be deleted from component blocks while in the uncommitted version of a flow. Non-custom components come pre-configured with default fields which cannot be deleted.

To delete a field, select the component block that contains the field you want to delete. In the panel for the component block, click the Fields tab for custom components block or the Config tab for all other component blocks and then click the name of the field you want to delete. In the Configure field modal that appears, click the Delete button at the bottom.

caution

Deleted fields can’t be recovered directly, however, fields will always continue to exist in previous versions of the flow. You can always restore a flow version to recover a field.

Accessing fields

Fields can be accessed per component block via API or SDK.

Learn more: