Video guide: Creating custom fields


Custom fields, before any definitions have been added.
The table
Each definition is a row with:- Label, with its help text underneath if it has any.
- Key, shown as a code chip.
- Applies to, reading All packages, a count of templates, or All packages, every workspace for a shared field.
- Required or Optional.
Adding or editing a definition
Add custom field (“Define a field senders fill in, and the key your integrations read it back by.”) asks for:- Label, for example
Employee ID. - Key, for example
employee_id. Keys are lowercase letters, digits and underscores, start with a letter, and cannot change once saved. - Help text, optional, shown to senders under the field.
- Required, a switch: senders must fill it before sending.
- Applies to, either All packages (“Every sender fills this in, whatever they’re sending.”) or Selected templates (“Only packages started from the templates you choose.”), which then asks you to pick them under Templates.


Adding a custom field.
Sharing a field with every workspace
When the organisation has more than one workspace, an owner adding a field sees an Every workspace switch (“Share this field with every workspace in the organisation. It applies to all packages, and stays shared once saved.”). A shared field:- Shows in every workspace’s list, and on every package in every workspace.
- Always applies to all packages, since templates belong to one workspace.
- Stays shared once saved.
- Can only be edited or archived by an owner. Other members see it in the list without the actions menu.

