Response Macros
In the app: Settings → Macros
Needs the 'View Macros' permission.
A macro is a saved reply that a teammate inserts into a message they are writing. Macros belong to the organization: a macro is written once and can be used in a conversation of any store.
Macro list
Each macro shows:
- its name;
- its shortcut, when it has one, written with a leading slash;
- its category, when it has one;
- the first lines of its text, without formatting;
- the variables it uses, each written between double curly brackets.
The pencil button opens the macro for editing. The bin button deletes it after you confirm. Teammates can then no longer insert it, and this cannot be undone. Replies that were already sent with the macro do not change.
"Create Macro" at the top opens an empty macro. When there are no macros, the page shows "No macros yet" with a "Create a macro" button and the link "Start from an example: shipping update". The link opens the form already filled in with an example; nothing is created until you save it.
If the list cannot be loaded, the page says so and offers "Try again".
Seeing this page needs the 'View Macros' permission. Creating, editing and deleting need the 'Edit Macros' permission.
Create or edit a macro
Needs the 'Edit Macros' permission.
"Create Macro" opens the "Create Macro" dialog; the pencil button opens "Edit Macro". Nothing is saved until you click "Create Macro" or "Save Changes".
"Name" is required and can be up to 255 characters. Teammates find the macro by it.
"Shortcut (optional)" is a short word teammates can type to find the macro quickly. Type it with or without a leading slash; Squid stores it in lower case with the slash. It may hold letters, digits, underscores and dashes, up to 50 characters including the leading slash. Each shortcut can be used by one macro only: a shortcut that is already taken is refused with "That shortcut is already used by another macro. Choose a different shortcut."
"Category (optional)" is a label of up to 100 characters, shown on the macro in this list, for example "Orders".
"Content" is required. It is the text that is inserted, with formatting such as bold, lists and links, up to 10,000 characters including formatting. Write a variable as its name between double curly brackets. Anything else is inserted exactly as written.
Once a macro has a shortcut or a category, emptying that field in "Edit Macro" does not remove it; the earlier value stays. Replace it with another value to change it.
Variables
A variable is replaced with the real value at the moment the macro is inserted. The dialog lists the variables under the content field; hover over one to read what it is.
- customer.name: the customer's full name.
- customer.first_name: the first word of the customer's name.
- customer.email: the customer's email address.
- agent.name: the name of the teammate who inserts the macro.
- agent.email: that teammate's email address.
- brand.name: the name of the store the conversation belongs to.
- conversation.subject: the conversation's subject line.
- conversation.id: the conversation's identifier.
A variable is filled in once, when the macro is inserted. The teammate sees the result in the message and can change it before sending.
A variable that is not on this list, or is misspelled, is not filled in: its name is inserted between square brackets, so the teammate can see something is missing. A customer without a name gives an empty value. On a conversation that has no customer, the three customer variables are left between square brackets.
When a rule uses the macro through its "Apply Macro" action (Settings → Rules), no teammate is involved, so agent.name and agent.email are left between square brackets. Do not use those two variables in a macro meant for rules.
Using a macro in a reply
In a ticket, a teammate opens the macro list from the "Insert Macro" button in the message editor, or by typing a semicolon in the message. In the plain-text chat composer, two slashes at the start of the message or after a space open it too. Typing further after the semicolon or the two slashes, or in the list's own "Search macros..." box, searches the macros by name and by shortcut; each word typed must appear in one of the two. Before you type a search word the list shows your organization's macros; a search shows up to 20 matches. The up and down arrow keys move through the list, Enter inserts the selected macro and Escape closes the list. A space after the semicolon or the slashes closes the list again.
Inserting a macro puts its text in the message with the variables filled in for that conversation. In the plain-text chat composer, formatting is converted to plain text. Nothing is sent: the teammate still reviews and sends the message.
Typing a shortcut with its single slash does not insert the macro by itself and does not open the list; the shortcut is a search word for the list above.
Using a macro needs the 'View Macros' permission. Each use is counted for reporting.