The Tyk Enterprise Developer Portal enables admin users to customize emails that are sent to the API consumers and admin users upon certain events that happen on the portal. As an admin user, you can fully customize emails that are sent from the portal. This section provides a guide to email customization.

​
Supported Email Notifications

The Tyk Enterprise Developer Portal sends notifications for the following events:
EventRecipientEmail subjectText templateHTML templateDefault template
Password resetUser who reset their passwordReset password email - subjectauth/reset.text.tmplauth/reset.html.tmplauth/reset.tmpl
New API access request is createdAll portal adminsAccess request sent for approval (not configurable)submitted.text.tmplsubmitted.html.tmplsubmitted.tmpl
API access request approvedDeveloperApprove access request - subjectapprove.text.tmplapprove.html.tmplapprove.tmpl
API access request rejectedDeveloperReject access request - subjectreject.text.tmplreject.html.tmplreject.tmpl
Pending developer registration requestAll portal adminsInvite new admin user - subjectnewuser.text.tmplnewuser.html.tmplnewuser.tmpl
An admin user is invited to register in the portalAdminDeveloper registration approval request - subjectinvite.text.tmplinvite.html.tmplinvite.tmpl
A developer is invited to register in the portalDeveloperInvite new user to a consumer organization - subjectauth/targeted_invite.text.tmplauth/targeted_invite.html.tmplauth/targeted_invite.tmpl
Admin or developer account is activatedActivated userActivate user - subjectactivate.text.tmplactivate.html.tmplactivate.tmpl
Admin or developer account is deactivatedDeactivated userDectivate user - subjectdeactivate.text.tmpldeactivate.html.tmpldeactivate.tmpl
New consumer organization registration requestAll portal adminsNew organization registration request - subjectorganisation_request.text.tmplorganisation_request.html.tmplorganisation_request.tmpl
Consumer organization registration request is approvedConsumer organization adminApprove organization registration request - subjectorganisation_approve.text.tmplorganisation_approve.html.tmplorganisation_approve.tmpl
Consumer organization registration request is rejectedConsumer organization adminReject organization registration request - subjectorganisation_reject.text.tmplorganisation_reject.html.tmplorganisation_reject.tmpl
New admin account is createdAdminWelcome email for admins - subjectwelcome_admin.text.tmplwelcome_admin.html.tmplwelcome_admin.tmpl
New developer account is createdDeveloperWelcome email for developers - subjectwelcome_dev.text.tmplwelcome_dev.html.tmplwelcome_dev.tmpl

​
Behavior of Welcome and Activation Emails

When creating a user account from the admin UI or via the admin APIs, an admin user can create the user account as active or inactive. The behavior of activation emails varies depending on whether the user account is activated upon creation:
  • If the user account is created as inactive, the portal will send the welcome email. Then, upon activation of the user account, it will send the activation email.
  • If the user account is created as active, the portal will only send the welcome email and will suppress the activation email.

​
Modification of Email Templates

To render an email, the portal uses the email templates that are contained inside /mailers directory of your active theme. To modify the templates, as an admin user, you need to download and unzip the theme that you want to modify:
  1. Navigate to the Themes menu.
  2. Download the theme that you want to modify: Download a theme
  3. Unzip the theme and navigate to the mailers folder: Mailers folder
  4. Inside the mailer folder there are two types of assets: layouts and templates:
  • The templates define the content for a specific email notification.
  • The layouts are responsible for displaying the content of the templates.

​
Layouts

These are three layouts:
  • HTML layout: emails.html.tmpl.
  • Text layout: emails.text.tmpl.
  • The default layout: emails.tmpl.
The HTML and text layout are used to render HTML and plain text content respectively. If the portal fails to find both the HTML and the text templates, it will use the default one. To display the content of a template, the layout use special keyword yield: {{ yield }}.

​
Templates

Each event has three email templates:
  • HTML template is used to display the HTML content in email client.
  • Text template is used to display the plain text content in email client.
  • Default template is used when neither HTML nor text templates is presented.
As an admin user, you can modify any of these templates.

​
Applying Changes to Themes

You need to upload the theme to the portal and activate it to make the changes to the email templates effectively:
  1. Navigate to the theme folder. Select all the files and compress them: Compress theme
  2. As an admin user, navigate to Theme menu. Select the theme you want to update and upload the theme archive: Upload a theme
  3. Once the theme archive is selected, click on the Save changes button to upload the archive: Upload a theme
  4. Finally, you need to activate the theme if it’s not already active: Activate a theme