Quick start guide
Here's our recommendation on how to quickly get started on Waypoint's email notification platform.
First, let's create our first template
Step 1: Create an account and workspace
Before we can do anything, we'll need to create an account and workspace. A workspace is where your team will collaborate on building templates, monitoring email activity, and more.
- If you haven't already, create a free account.
- Go to your Waypoint dashboard
- Click the big '+' to add a new workspace.
- Give the new workspace a name and click 'Create'.
Step 2: Create your first template
Next, we'll create a template. For this quickstart tutorial, we'll use a sample template as the base.
- Within your new workspace, click on the 'Templates' link at the top.
- Click '+ New'
- Within the 'From samples' tab, click on the 'New comment' sample template.
- Click on 'Untitled template' in the header to rename the template to on a more descriptive one (eg. 'New comment').
Step 3: Send a preview email
From Waypoint's template builder, make adjustments to the template and then send yourself a quick preview email.
- Make any desired changes to the template – learn more about building templates.
- Go to the 'General' tab on the template builder.
- Within the 'Test this template' section, click on the 'Send test' button. This will send yourself an email with any live changes.
- When you are happy with the changes, click 'Save' in the header to save the template.
Now let's hook it up to the API
Step 4: Create an API key
Now that the email template is setup and it's rendering correctly, let's hook it up to the API. We'll first need to head back to your settings page to create an API keys so your application can send data to Waypoint.
- Navigate to the 'Settings' page of your workspace.
- Scroll down to the 'API keys' section, click on '+ Add key', and then follow the directions to finish adding the key.
- After creating the key, scroll down to the bottom of the 'Settings' page and you should now see your new API key with a
Password. We'll use these in a later step.
Step 5: Send your first API request
Next let's create the actual API request that passes in the variables that the template is expecting.
From the API endpoint reference, you can see that we'll be passing in the following data:
|templateId||The id of the template you want to send.|
|variables||JSON data object that is passed to the template.|
|to||Email address of the receiver.|
Within your application, following the instructions and code example below to setup and run your API request.
- From the template builder, switch to the 'Data' tab. This is the data that this particular template is expecting in order to populate the template.
- Copy the JSON data and paste it into the
variablesproperty on the API request within your application. Modify the data to map your dynamic data or simply adjust the hardcoded data for testing.
- Switch to the 'General' tab in the template builder to copy the template ID at the bottom.
- Paste the template ID into the
templateIdvariable on the API request.
- Set the
tofield to be be the email address of someone in your workspace (see trial plan limitations).
- Copy and paste your
passwordkeys (from Step 3) into the
authobject in your API request.
- Run the API request.
💡 Use Node.js? Write even less code in your codebase by using the Waypoint npm package.
Now let's debug
Step 6. Review API request
Head to your 'Activity' page to ensure the test API request came through with the expected template data.
If successful, you should see both your preview email and your test request within your Activity events list. You can click on each item to drill down and see the full timeline of event logs along with metadata, the full email content, and template data.
Not seeing the request come through? We're happy to help – email@example.com.
Everything look good?
Whenever you and your team are ready, we recommend the following next steps: