Skip to main content
Custom fields (“Define the fields senders fill in on every package in this workspace.”) requires the Enterprise plan; on a lower plan the section shows an upgrade prompt instead. Managing them also requires the manage custom fields permission, without which the page reads You don’t have access to custom fields.

Video guide: Creating custom fields

The custom fields settings page with an empty tableThe custom fields settings page with an empty table

Custom fields, before any definitions have been added.

Custom fields belong to the workspace you are in. Each workspace keeps its own list, and two workspaces can use the same key for different fields. Switch workspace to manage another workspace’s fields. An organisation owner can also share a field with every workspace; see Sharing a field with every workspace. Fields that existed before each workspace had its own list were copied across: those applying to all packages into every workspace, and those for selected templates into the workspaces that hold those templates. Definitions are live: what you add here is what senders fill in on every package it applies to, and the value is carried through to the API and every webhook payload under its key.

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.
A row’s actions menu offers Edit and Archive; clicking the row opens it for editing. An empty list shows No custom fields yet: “Add a field like an employee ID and every package it applies to will carry that value through to your integrations.”

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.
A label holds up to 60 characters, a key 40 and help text 200. Every custom field is a single text value of up to 500 characters. Editing an existing field (“Change what senders see. The key stays as it is.”) offers the same form with the key locked, saved with Save changes.
The add custom field dialog with Label, Key, Help text, Required and Applies to fieldsThe add custom field dialog with Label, Key, Help text, Required and Applies to fields

Adding a custom field.

A workspace can have up to 20 custom fields, counting shared ones. Once it reaches that, archive one to add another.

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.
Its key must not already be in use in any workspace, and no workspace can add a field with its key afterwards.

Archiving

Archive custom field (“Senders will stop seeing this field.”) removes the field from new packages. Choosing Archive from a row’s menu opens this dialog, and Archive field confirms it. Packages already sent keep the values they hold, and your integrations stop receiving the key in their metadata. Archiving can’t be undone from the app, and an archived field’s key can’t be used again in that workspace.