Introduction
Waypoint is a transactional email platform where your team can collaborate on building templates and monitoring emails that have been sent. This document is an API reference to guide developers on how to trigger email templates created on Waypoint with a simple API call.
Introduction
Waypoint is a transactional email platform where your team can collaborate on building templates and monitoring emails that have been sent. This document is an API reference to guide developers on how to trigger email templates created on Waypoint with a simple API call.
Introduction
Waypoint is a transactional email platform where your team can collaborate on building templates and monitoring emails that have been sent. This document is an API reference to guide developers on how to trigger email templates created on Waypoint with a simple API call.
Authentication
Waypoint uses an USERNAME and PASSWORD pair to allow access to the API through Basic HTTP Authentication (this is not the same as your Waypoint dashboard username/password).
To access or generate a new API key USERNAME/PASSWORD:
Go 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: back on your 'Settings' page, you should now see your API key USERNAME and PASSWORD.
This USERNAME and PASSWORD is used in the Authorization header within your API call. See example below for details.
Authentication
Waypoint uses an USERNAME and PASSWORD pair to allow access to the API through Basic HTTP Authentication (this is not the same as your Waypoint dashboard username/password).
To access or generate a new API key USERNAME/PASSWORD:
Go 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: back on your 'Settings' page, you should now see your API key USERNAME and PASSWORD.
This USERNAME and PASSWORD is used in the Authorization header within your API call. See example below for details.
Authentication
Waypoint uses an USERNAME and PASSWORD pair to allow access to the API through Basic HTTP Authentication (this is not the same as your Waypoint dashboard username/password).
To access or generate a new API key USERNAME/PASSWORD:
Go 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: back on your 'Settings' page, you should now see your API key USERNAME and PASSWORD.
This USERNAME and PASSWORD is used in the Authorization header within your API call. See example below for details.
Verify senders
Before you are able to send emails from your domain through Waypoint, you'll need to verify your email address so we can ensure that you own it. During private beta, this is a manual process – contact support for assistance.
Once your sender email address has been verified and you have an API key, you can begin triggering emails following the example below.
Verify senders
Before you are able to send emails from your domain through Waypoint, you'll need to verify your email address so we can ensure that you own it. During private beta, this is a manual process – contact support for assistance.
Once your sender email address has been verified and you have an API key, you can begin triggering emails following the example below.
Verify senders
Before you are able to send emails from your domain through Waypoint, you'll need to verify your email address so we can ensure that you own it. During private beta, this is a manual process – contact support for assistance.
Once your sender email address has been verified and you have an API key, you can begin triggering emails following the example below.
API information
The Waypoint API uses the URL https://live.waypointapi.com and a Content-Type: application/json to encode the data.
API information
The Waypoint API uses the URL https://live.waypointapi.com and a Content-Type: application/json to encode the data.
API information
The Waypoint API uses the URL https://live.waypointapi.com and a Content-Type: application/json to encode the data.
Triggering emails
POST /v1/email_messages
Send an email using a template created on the Waypoint dashboard. Pass in data to use as variables on your template. Take advantage of the Liquid Templating Language to add conditionals, loops, and formatting within your templates.
Attribute
Description
templateId
The id of the template you want to send (created on the Waypoint dashboard).
to
Email address of the receiver. It can be an email address or use the “Display Name <email address>” format.
variables
Variables that are passed to the template.
Triggering emails
POST /v1/email_messages
Send an email using a template created on the Waypoint dashboard. Pass in data to use as variables on your template. Take advantage of the Liquid Templating Language to add conditionals, loops, and formatting within your templates.
Attribute
Description
templateId
The id of the template you want to send (created on the Waypoint dashboard).
to
Email address of the receiver. It can be an email address or use the “Display Name <email address>” format.
variables
Variables that are passed to the template.
Triggering emails
POST /v1/email_messages
Send an email using a template created on the Waypoint dashboard. Pass in data to use as variables on your template. Take advantage of the Liquid Templating Language to add conditionals, loops, and formatting within your templates.
Attribute
Description
templateId
The id of the template you want to send (created on the Waypoint dashboard).
to
Email address of the receiver. It can be an email address or use the “Display Name <email address>” format.
variables
Variables that are passed to the template.