Customize Email Notification in Developer Portal

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:

Event	Recipient	Email subject	Text template	HTML template	Default template
Password reset	User who reset their password	Reset password email - subject	auth/reset_password.text.tmpl	auth/reset_password.html.tmpl	auth/reset_password.tmpl
New API access request is created	All portal admins	Access request sent for approval (not configurable)	submitted.text.tmpl	submitted.html.tmpl	submitted.tmpl
API access request approved	Developer	Approve access request - subject	approve.text.tmpl	approve.html.tmpl	approve.tmpl
API access request rejected	Developer	Reject access request - subject	reject.text.tmpl	reject.html.tmpl	reject.tmpl
Pending developer registration request	All portal admins	Invite new admin user - subject	newuser.text.tmpl	newuser.html.tmpl	newuser.tmpl
An admin user is invited to register in the portal	Admin	Developer registration approval request - subject	auth/targeted_invite.text.tmpl	auth/targeted_invite.html.tmpl	auth/targeted_invite.tmpl
A developer is invited to register in the portal	Developer	Invite new user to a consumer organization - subject	auth/targeted_invite.text.tmpl	auth/targeted_invite.html.tmpl	auth/targeted_invite.tmpl
Admin or developer account is activated	Activated user	Activate user - subject	activate.text.tmpl	activate.html.tmpl	activate.tmpl
Admin or developer account is deactivated	Deactivated user	Dectivate user - subject	deactivate.text.tmpl	deactivate.html.tmpl	deactivate.tmpl
New consumer organization registration request	All portal admins	New organization registration request - subject	organisation_request.text.tmpl	organisation_request.html.tmpl	organisation_request.tmpl
Consumer organization registration request is approved	Consumer organization admin	Approve organization registration request - subject	organisation_approve.text.tmpl	organisation_approve.html.tmpl	organisation_approve.tmpl
Consumer organization registration request is rejected	Consumer organization admin	Reject organization registration request - subject	organisation_reject.text.tmpl	organisation_reject.html.tmpl	organisation_reject.tmpl
New admin account is created	Admin	Welcome email for admins - subject	welcome_admin.text.tmpl	welcome_admin.html.tmpl	welcome_admin.tmpl
New developer account is created	Developer	Welcome email for developers - subject	welcome_dev.text.tmpl	welcome_dev.html.tmpl	welcome_dev.tmpl
A credential is about to expire	Credential owner (developer)	Your Credential is about to expire (not configurable)	keytoexpire.text.tmpl	keytoexpire.html.tmpl	keytoexpire.tmpl
A credential has expired	Credential owner (developer)	Your Credential has expired (not configurable)	keyexpired.text.tmpl	keyexpired.html.tmpl	keyexpired.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:

Navigate to the Themes menu.
Download the theme that you want to modify:
Unzip the theme and navigate to the mailers folder:
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:

Navigate to the theme folder. Select all the files and compress them:
As an admin user, navigate to Theme menu. Select the theme you want to update and upload the theme archive:
Once the theme archive is selected, click on the Save changes button to upload the archive:
Finally, you need to activate the theme if it’s not already active: