Custom Fields
Custom fields let you add your own data points to events, contacts, and addresses. Once you define a field, it becomes available in the form builder, on the event detail page, in workflows, and in templates and integrations -- everywhere you need it.
How to open
- Go to Settings in the navigation.
- Click Custom Fields.
Only owners and admins can manage custom fields.
Areas
Custom fields live in one of three areas:
- Event -- general event data (e.g. budget codes, campaign IDs).
- Contact -- extra contact details (e.g. loyalty tier, vendor reference).
- Address -- additional address details (e.g. floor, entry code).
Switch between areas using the tabs at the top of the page.
Creating a custom field
- Select the tab for the area you want.
- Click Add custom field.
- Fill in the basics:
- Area -- where the value lives on an event.
- Key -- a short, snake_case identifier (lowercase letters, digits, and underscores). The key is locked once the field is used.
- Label -- the user-facing name that appears in pickers and the event detail page.
- Description -- optional helper text shown in the form builder and settings.
- Pick a Data type. The matching Form field type is selected automatically. Supported types include text, number, date, time, yes/no, single select, multi select, email, phone, and URL.
- For Single select or Multi select, add at least one option. Each option has a unique value and a user-facing label.
- Choose where this field should appear using the Where this field appears toggles. See Surfaces below.
- Click Save.
The generated Mapping key (e.g. event.budget_code) is shown below the key field. Use the mapping key when referencing the field in workflows, templates, and integrations.
Surfaces
Each custom field can appear in several surfaces. Some surfaces depend on others -- Persist to event is the main gate for everything below it.
| Surface | What it does | Requires |
|---|---|---|
| Available in the form builder | Shows the field in the form builder field picker. | -- |
| Persist to event | Saves the value onto the event so other surfaces can read it. | -- |
| Visible on event detail | Shows the value on the event detail page. | Persist to event |
| Editable on event detail | Allows editing on the event detail page. | Visible on event detail |
| Usable in workflow conditions | Lets workflows read the field in conditions. | Persist to event |
| Usable in workflow triggers | Lets workflows trigger when the field changes. | Persist to event |
| Writable by workflow actions | Lets workflow actions update the field. | Persist to event |
| Available as template variable | Use the field in email and text templates. | Persist to event |
| Expose in public API | Include the field in tenant API responses. | Persist to event |
| Expose in webhooks | Include the field in outgoing webhook payloads. | Persist to event |
When you turn a parent toggle off, dependent toggles are cleared automatically.
Editing a custom field
- Open the area tab where the field lives.
- Click the three-dot menu on the field.
- Click Edit custom field.
Area and Key are locked once the field is in use by any form, response, workflow, or event. Label, description, options, sort order, and surface toggles can be changed at any time.
Archiving a custom field
- Open the three-dot menu on the field.
- Click Archive custom field and confirm.
Archiving hides the field from pickers and new forms but preserves all existing values and references. Toggle Show archived to see archived fields in the list.
Using custom fields in forms
Create or edit a form where the type allows events (event forms, or detail forms with event updates enabled). In the form builder, your custom fields appear directly under the matching area tab (Event, Contact, or Address) as a Custom Fields sub-section. Adding one places a field that is linked to your custom field and persists its value back to the event on submit.
Custom fields on the event detail page
Custom fields appear on the event detail page where they belong:
- Event fields appear in the Event Details section on the main event page.
- Contact fields appear at the bottom of the Contact block.
- Address fields appear at the bottom of the Address block.
The Event Details section is shown only when at least one active event custom field is exposed on the event detail page. Fields you marked as not editable are displayed read-only.
Using custom fields in workflows
- Conditions -- pick the field in condition configs to compare values.
- Triggers -- choose the field in the "Event field changed" trigger to watch for changes.
- Actions -- choose the field in the "Update event field" action to let the workflow write a new value.
Only fields you've enabled for the respective surface appear in the dropdown.
Limits
- Up to 100 active custom fields per workspace.
- Keys use lowercase letters, digits, and underscores (between 2 and 64 characters) and cannot collide with reserved Eventyflow fields. The form flags reserved keys when you save.
- Single and multi select fields require at least one option with a unique value.