You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Enhances the "Configure Invitation and Notification Emails" section to make template variables more discoverable:
- Adds detailed step-by-step instructions for editing email templates
- Documents template variable syntax ({{variable_name}})
- Provides usage examples for subject lines and email bodies
- Adds a reference table of common template variables
- Emphasizes checking the UI's "Available Variables" section for each email type
Related to replicatedhq/vandoor#8402
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <[email protected]>
Copy file name to clipboardExpand all lines: docs/vendor/enterprise-portal-configure.mdx
+46-1Lines changed: 46 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,12 +76,57 @@ To configure customer emails:
76
76
1. For **Email Sender Verification**, in **From email address**, add the email address that you want to use as the sender for all system notifications sent to your customers, then click **Continue**. Adding a sender address helps ensure that your emails are delivered and are not marked as spam.
77
77
78
78
After the domain is verified automatically, the email address is displayed under **Verified Sender Address**.
79
-
1. For **Customer Emails**, customize the subject line and body of the emails that are sent to your customers for various system events. You can also customize the default style component to change things like color and font. Click **Preview** to see a preview of your changes.
79
+
1. For **Customer Emails**, customize the subject line and body of the emails that are sent to your customers for various system events. Email templates support dynamic variables that are automatically populated with relevant data when emails are sent.
[View a larger version of this image](/images/enterprise-portal-customer-emails-edit.png)
84
84
85
+
To edit a template:
86
+
87
+
1. Click the email type you want to customize to expand the template editor.
88
+
1. Modify the **Subject line** and **Email body** fields.
89
+
1. Use template variables (formatted as `{{variable_name}}`) to insert dynamic content.
90
+
1. Check the **Available Variables** section below the email body editor to see which variables you can use for this specific email type.
91
+
1. Click the **Preview** tab to see how your email will look with sample data.
92
+
1. Click **Save changes** when finished.
93
+
94
+
You can also customize the default style component to change things like color and font.
95
+
96
+
### Using Template Variables
97
+
98
+
Variables are displayed in the UI under **Available Variables** when you expand an email template. These variables differ by email type - always check what's shown in the UI for the template you're editing.
99
+
100
+
**Variable syntax:**`{{variable_name}}`
101
+
102
+
**Example usage:**
103
+
- Subject: `Welcome to {{app_name}}!`
104
+
- Body: `Click here to join {{team_name}}: {{invite_url}}`
105
+
106
+
:::info Check the UI for Available Variables
107
+
Each email template has different variables available. When editing a template, look for the **Available Variables** section below the email body editor - it shows exactly which variables you can use for that specific email type.
108
+
:::
109
+
110
+
### Common Template Variables
111
+
112
+
The following variables are commonly available across multiple email types:
113
+
114
+
| Variable | Description | Example Output |
115
+
|----------|-------------|----------------|
116
+
|`{{app_name}}`| Your application name | "Acme Application" |
117
+
|`{{team_name}}`| Customer team name | "Acme Corp" |
118
+
|`{{customer_name}}`| Customer organization name | "Acme Corporation" |
119
+
|`{{login_url}}`| Link to login page |https://portal.example.com/acme/login|
120
+
|`{{invite_url}}`| Link to accept invitation |https://portal.example.com/acme/invite#token|
|`{{version_label}}`| Software version number | "1.2.3" |
123
+
|`{{release_notes}}`| Release notes content | "New features and bug fixes" |
124
+
|`{{update_url}}`| Link to update/release page |https://portal.example.com/acme/releases|
125
+
126
+
:::note
127
+
Not all variables are available for every email type. Always check the **Available Variables** section in the UI for the specific template you're editing.
128
+
:::
129
+
85
130
## Add a Link to Documentation
86
131
87
132
For each of your supported install types, you can add a link your installation documentation. The link you provide is displayed on the Enterprise Portal **Install** page.
0 commit comments