Customize Email Templates
The content of all standard email communication with developers can be completely customized. This allows you to closely match the workflows which you have selected for your portal.
At the end of this section you will edit and save a custom email notifications.
Step by Step
Step 1: Define your Workflows before Email configuration
There are a lot of potential email templates. However only a subset of them are likely to be relevant for your environment, depending on how you have setup your workflows. You can save yourself time, by making sure you are happy with your workflows, before you begin the task of editing the email templates. This way you only have to edit the templates that you will actually use.
Step 2: Test your Workflow and identify Active Email Templates
Perform a dry run of your finalized workflows, making sure to test all the possible branches (e.g. approval and rejection). Then identify each email notification that is received by your test developer account in the dry run, and make the edits in the next step.
Notice that all the email templates differentiate whether they are notifications for your developers (or “buyer”), or for the admins (of your API “provider” account).
Step 3: Edit and Save your Custom Template
The first time you edit a template, you will actually “create” a custom template. Then in subsequent edits, you “save” your changes. Warning: there is no version control. It is recommended that you make a local copy if you want to be able to revert changes.
You can use the “notes” field for any internal notes (which are not visible in the email content). These can be useful to keep track of which email templates are currently in use for your workflows.
Liquid tags can also be used for dynamic content in your email. It is especially recommended to make backups when you make changes to the liquid tags.
Step 4: Repeat for all Templates in your Workflows
Complete these same steps until you have covered all the possible branches for your workflows.
Step 5: Optionally Repeat for Notifications to Admins
Normally you probably do not need to customize notifications to your own admins. However in larger organizations you may want to complete these additional steps. This can be used to provide instructions on what actions to take, in the context of the notification. The steps to customize these emails are exactly the same as for your developer emails.