Custom Alerts: Creating your Template

Your marketplace will come with a set of automated email alerts and SMS notifications (text messages), which are triggered by certain actions that your users can take. For instance, when a new user signs up on your site, they will automatically receive an email welcoming them to your marketplace. This email template, and a host of others, comes out of the box - but you have the option to either manage the content in these emails, or create your own templates and specify when they should be sent.

An overview of Email Layouts, Alerts (email, SMS and API) and Workflows can be watched here:
(or keep reading the article for step-by-step instructions for editing the defaults or creating your own email template.)

When creating custom alerts and notifications, you will need to take two steps:

  1. First, you will need create an SMS, API or Email template, which defines the content of the alert (i.e. the body of your new email, API call, or the message that is sent via SMS)
  2. Then, you will need to specify what action, or workflow, should trigger that template. For instance, you may want to send your users an email when they successfully sign up on your marketplace - in this case, the action 'signed up' would be your workflow.

CREATING YOUR TEMPLATE

To begin, we'll create an example email template as per step 1 above:

1) Start by logging into your admin dashboard, and navigating to Manage > Emails. Note that if you are creating a custom text message alert, you will want to go to Manage > Smses (the process of creating a template for emails, API calls and SMS notifications is essentially the same)

On this page, you will find a list of all email templates that are sent by the platform by default, under 'Customize Default'. Note that you can edit these by selecting either the 'html' or 'text' link to the right of each template. We will discuss the difference between these further along in this guide.

For now, select 'Add Email Template'

2) The following page is where you will define your new email template. You will be able to give it a name, specify the format to use, and write all of the content for the email body.

To start, you will want to give your new template a name - which can be specified under 'Template Path'. This name is for your use, and won't be surfaced to the user. Be sure to specify a name that you will recognize later on when creating the workflow.

Next, choose a service type. Generally you will only have a single service type, but if you have set up multiple transactable types then you can specify which type this template should belong to.

You will then be asked to specify the format for the email. This option is only available for emails, and allows you to create separate templates for text and html. Note that a vast majority of your users will likely be utilizing email clients that accept HTML (gmail, for instance, is one such email client). However, some of your users will be using clients that do not accept HTML, in which case you are encouraged to create two separate templates - an HTML template and a corresponding plain text template.

Finally, you can enter all of the content for your email in the 'Body' field below. When you are finished, select 'save' at the bottom of the screen.

When ready, take a look at our guide on  creating your own workflow so that you can trigger the template you just made!