SquidSupport
Product reference / Settings

Custom Fields

In the app: Settings → Custom Fields

Needs the 'View Custom Fields' permission.

Custom fields are extra pieces of data your team records on a ticket, such as an order number or a contact reason. A field is defined once for the organization and appears on every ticket in every store, in the ticket details beside the conversation.

Field list

The list shows every field, active and inactive. Each row shows:

  • an icon for the field's type, and the field's name;
  • its key, the fixed identifier used by the API;
  • its type: "Text", "Number", "Date", "Dropdown", "Checkbox" or "Multi Select";
  • a "Required" badge when a value is needed before a teammate can close a ticket;
  • an "Inactive" badge when the field is switched off;
  • its description, when it has one;
  • an eye icon when "Show in conversation list" is on for the field.

The three-dot button on a row opens a menu with "Edit Field", "Deactivate" or "Activate", and "Delete Field".

"Create Field" at the top opens an empty field. When there are no fields, the page shows "No custom fields yet" with a "Create Your First Field" button. If the list cannot be loaded, the page says so and offers "Try again".

Seeing this page needs the 'View Custom Fields' permission. Creating, editing, activating, deactivating and deleting need the 'Edit Custom Fields' permission; without it those actions are refused.

The same two permissions apply on a ticket: reading a ticket's field values needs 'View Custom Fields' and saving a value needs 'Edit Custom Fields'. There are two exceptions. Someone who may view and close tickets can fill in the required fields when closing, also without 'Edit Custom Fields'. And someone who creates a ticket from the Inbox can fill in the fields shown in "Create ticket" with only the 'Create Conversations' permission.

Create or edit a field

Needs the 'Edit Custom Fields' permission.

"Create Field" opens the "Create Custom Field" dialog; "Edit Field" opens "Edit Custom Field". Nothing is saved until you click "Create Field" or "Save Changes".

"Field Name" is required and can be up to 100 characters. It is the label teammates see on the ticket.

"Field Key" is required. It is filled in from the name while you create a field, and you can change it before saving. It must start with a lower-case letter and may hold only lower-case letters, digits and underscores, up to 50 characters. Each key can be used once in the organization. It cannot be changed after the field is created.

"Field Type" decides what kind of value the field holds. It cannot be changed after the field is created.

"Description" is optional and is shown in this list.

"Default Value" is optional. A ticket that has no saved value for the field shows the default. The default is only displayed: it is not saved on the ticket, so it does not count as an answer for a required field.

When you edit a field, emptying "Description", "Default Value" or "Validation Pattern" does not remove the stored text; the earlier text stays. Replace it with other text to change it.

Field types and options

Needs the 'Edit Custom Fields' permission.

  • "Text": free text, up to 10,000 characters.
  • "Number": a number. Text that is not a number is refused.
  • "Date": a date.
  • "Checkbox": yes or no.
  • "Dropdown": one choice from a list of options.
  • "Multi Select": any number of choices from a list of options.

"Options" appears for "Dropdown" and "Multi Select". Each option has a "Label", which teammates see, and a "Value", which is stored and used by the API. The value is filled in from the label as lower-case words joined by underscores; you can type your own. "Add Option" adds a row and the cross removes one. At least one option is required, and every option needs both a label and a value. A ticket can only be given a value that is on the list.

"Validation Pattern" appears for "Text" and "Number". It is an optional regular expression that a value must match in full, for example a pattern for an order number. A value that does not match is refused when a teammate saves it. Leave it empty for no check. Squid does not check the pattern itself when you save the field: a pattern that is not a valid regular expression makes every value for the field be refused.

Required fields and other switches

Needs the 'Edit Custom Fields' permission.

"Required when an agent closes a ticket" is off by default.

When it is on, a teammate cannot close a ticket until a value for this field is saved on it. This applies however they close it, including sending a reply that also closes the ticket. The message names the fields that are still missing. A checkbox that is saved as unticked and a number saved as zero count as filled in; a default value that was never saved does not, and neither does a "Multi Select" saved with nothing selected.

It only applies when a person closes the ticket. It does not apply to tickets closed by the AI or by automation, and it does not apply to an inactive field.

"Show in conversation list" is off by default. Turning it on marks the field with an eye icon in the list on this page. It does not add a column to the inbox.

Both switches apply to the whole organization and take effect when you save.

Deactivate or delete a field

Needs the 'Edit Custom Fields' permission.

"Deactivate" switches a field off without deleting anything, and without asking for confirmation. The field disappears from tickets and is no longer required for closing, and the values already saved are kept. "Activate" brings the field and its values back. Both take effect at once.

"Delete Field" asks for confirmation, then removes the field and every value stored for it on every ticket. This cannot be undone. To stop using a field but keep its data, deactivate it instead.