Waypoint documentation | Changelog

Failed message alerts

Fri, 12 Dec 2025 00:00:00 GMT

Available on Growth and Pro plans - teams using our email API can now receive alerts when messages fail to send.

This helps teams catch configuration and data issues early, before it impacts their users.

Alerts can be enabled from a new section within the Settings page.

When enabled, any errors within an hourly batch are grouped into a single email summary and sent to all members of the workspace.

Learn more about alerts

Large attachments

Thu, 02 Oct 2025 00:00:00 GMT

Earlier this year, we released attachments on Waypoint. Since then, customers have loved the ability to include files with their emails.

However, one key limitation has been size: emails with standard attachments are capped at 5 MB.

Starting today, Growth customers can send emails with attachments up to 10 MB and Pro customers up to 20 MB. This unlocks including larger files such as custom reports, presentations, detailed invoices, or higher-quality assets.

Learn more about sending with large attachments

Reply threading

Fri, 12 Sep 2025 00:00:00 GMT

Keep the conversation together. With our latest API updates, you can now thread related messages into the same email chain by simply adding a unique thread reference ID when sending an email API.

Example of threaded replies on Gmail sent through Waypoint.

View code example

Send emails from third party webhooks

Sat, 05 Jul 2025 00:00:00 GMT

Earlier this year, we released sending webhooks based on delivery events.

Today, we are introducing the opposite - receiving webhooks events from third party services to send emails.

Common event examples:

A successful payment on Stripe.
A new pull request on GitHub.
A new user account created on Auth0.
An new order on Shopify.
A shipping status change on Shippo.

This is done by creating a webhook endpoint URL on Waypoint to listen for third-party events and trigger associated workflows (and resulting dynamic emails).

View Stripe webhook example

Customize your unsubscribe experience

Thu, 19 Jun 2025 00:00:00 GMT

Tailor the text that appears in your unsubscribe links and unsubscribe landing pages directly within your Unsubscribe Group settings. This gives you full control over the messaging users see when managing their email preferences.

This is especially useful for localization, allowing you to present unsubscribe options in different languages or regional tones to better match your audience.

Attachments

Thu, 15 May 2025 00:00:00 GMT

Attachments have arrived on Waypoint.

Attachments have been one of our most requested features. After months of beta testing, we’re excited to make them generally available to all Waypoint customers.

You can now send emails with two types of attachments:

Standard attachments – Files included with an email but not shown in the message body (for example, PDFs or spreadsheets).
Inline attachments – Files, usually images, that are embedded directly within the email content.

Both types are added by including an attachments object in your API request. Example below:

const axios = require('axios');
const fs = require('fs');

// Read and encode the file to base64
const filePath = './order-receipt.pdf';
const fileContent = fs.readFileSync(filePath);
const base64Content = fileContent.toString('base64');

// Send the email with attachment
axios({
  method: "post",
  url: "https://live.waypointapi.com/v1/email_messages",
  headers: {
    "Content-Type": "application/json"
  },
  auth: {
    username: API_KEY_USERNAME,
    password: API_KEY_PASSWORD
  },
  data: {
    "templateId": "wptemplate_ABc123XYZ",
    "to": "jordan@usewaypoint.com",
    "variables": {
      "user": {
        "displayName": "Jordan",
      },
      "product": {
        "title": "Beechers Mac & Cheese",
        "id": "02934203942"
      }
    },
    "attachments": [
      {
        "name": `order-receipt.pdf`,
        "contentBlob": base64Content,
        "contentType": 'application/pdf',
      },
    ],
  }
})
.then(function (response) {
  console.log(response);
})
.catch(function (error) {
  console.log(error);
})

Additionally, within your activity, messages sent with one or many attachments, will show the attachment name underneath the message preview.

Email message metadata

Thu, 17 Apr 2025 00:00:00 GMT

A small but mighty improvement for dev teams – metadata is now supported on Waypoint email messages. This allows teams to attach additional context for internal use and reference.

For example, when sending an email API via the API, you might want to include extra context. In the snippet below, we’re passing in a customerId, companyId, and transactionId:

POST v1/email_messages

Terminal window

curl "https://live.waypointapi.com/v1/email_messages" \
  -H "Content-Type: application/json" \
  -u "API_KEY_USERNAME:API_KEY_PASSWORD"  \
  -d '{
    "to": "jordan@usewaypoint.com",
    "templateId": "wptemplate_tuVKkNrLgZfM6KyQ",
    "variables": {
      "displayName": "Jordan"
    },
    "metadata": {
      "customerId": "customer_10928q3093840aap",
      "companyId": "company_sdafljaw09330r36",
      "transactionId": "transaction_a20394a339aa390a"
    }
  }'

This metadata isn’t just available when fetching individual emails API — it’s also included visible on message detail pages in your dashboard.

Additionally, message metadata is also accessible from webhook payloads. Example:

{
  "createdAt": "2025-04-21T14:03:01.357Z",
  "emailMessage": {
    ...
    "metadata": {
      "customerId": "customer_10928q3093840aap",
      "companyId": "company_sdafljaw09330r36",
      "transactionId": "transaction_a20394a339aa390a"
    }
  },
  "emailMessageId": "em_wUpG2hHHvfncz8EY",
  "id": "log_vJayu2MEA7ZZXTuQ",
  "message": "Email successfully delivered to jordan@usewaypoint.com. Delivery time: 0.2 seconds.",
  "updatedAt": "2025-04-21T14:03:01.357Z"
}

Activity search

Sat, 15 Mar 2025 00:00:00 GMT

Perform searches within your activity page to quickly find messages created within your workspace.

Your browser does not support the video tag.

To search:

Navigate to your ‘Activity’ page within your workspace.
Click on the magnifying glass icon.
Add a search term.
Hit Enter.

Learn more in our docs

API endpoint: List emails

Mon, 17 Feb 2025 00:00:00 GMT

Use our new email messages API endpoint to pull a report of your email messages, with optional date filters. Get the full picture, including delivery events like bounces, clicks, and complaints.

GET v1/email_messages

Terminal window

curl "https://live.waypointapi.com/v1/email_messages?createdAt.gt=2024-02-11T17:53:00Z" \
-H "Content-Type: application/json" \
-u "API_KEY_USERNAME:API_KEY_PASSWORD"

Updated docs

Fri, 31 Jan 2025 00:00:00 GMT

Our docs have been refreshed with updated guides, improved navigation, and a smarter search.

API endpoint: batch message report

Sat, 11 Jan 2025 00:00:00 GMT

With our new batch email messages API endpoint, you can now get a report with all of the email messages that were sent through an email batch. See the full context for each of your emails in your batch including delivery events like bounces, clicks, and complaints.

GET v1/batches/:id/email_messages

Terminal window

curl "https://live.waypointapi.com/v1/batches/batch_RmETGV42naFpgHjr/email_messages" \
-H "Content-Type: application/json" \
-u "API_KEY_USERNAME:API_KEY_PASSWORD"

Email Tracking Settings

Mon, 02 Dec 2024 00:00:00 GMT

By default, Waypoint tracks events for clicks and opens. This allows teams to gather insights around activity within individual emails.

To track opens, Waypoint places a 1x1 pixel transaprent image within each message to track every time someone opens an email. To track clicks, Waypoint modifies (and masks) all links in a message to use a proxy URL to record the click before redirecting to the destination.

Due to these tradeoffs, teams may decide to turn these tracking settings off. These options can now be configured directly within your workspace settings page.

Webhooks

Wed, 06 Nov 2024 00:00:00 GMT

One of our most requested features is now available – webhooks. Webhooks are how services notify each other of events. On Waypoint, customers can use webhooks take action after an email event like a ‘bounce’ or ‘delivery’ has happened.

For example, posting a notification in a Slack channel whenever an email bounces or is marked as spam.

Add custom webhook endpoint URLs or use our Slack and Zapier integrations to make it even easier to connect and transform your data as needed.

Improved user management and roles

Mon, 14 Oct 2024 00:00:00 GMT

Workspaces now include improved user management and roles to support additional team flexibility. This includes:

A new workspace ‘Owner’ role.
Owners can reassign ownership to another admin.
Owners and Admins can now remove users and open invites.

As always, teams on Waypoint can add an unlimited amount of admins and users to their workspace for no additional cost.

API endpoint: email message timeline events

Wed, 09 Oct 2024 00:00:00 GMT

Our new email message events API endpoint gives teams the ability to access the full timeline of events on an individual email message. These events include when the message was created, every open, click, bounce, or any other event found in our email event message logs.

This is especially helpful for teams that want to show this timeline of events to their own customers. For example, a CRM software platform may want to show these delivery events to help their customers better understand deliverability.

GET /v1/email_messages/EMAIL_MESSAGE_ID/events

Dynamic Colors on Templates

Wed, 21 Aug 2024 00:00:00 GMT

Waypoint’s new dynamic colors feature allow teams to theme email templates based on data. This is especially useful for vertical SaaS platforms (eg. software for yoga studios) that want to apply their customer’s branding and colors on email templates instead of their own. View an example/tutorial.

At the heart of Waypoint’s template builder is the use of data variables to apply the dynamic elements of a template. While these variables are most often used for dynamic text and images, they can now be used to set dynamic colors on a template or layout.

From a template or layout builder, simply click on the {} icon next to a color within the global ‘Styles’ tab to set a theme color override based on data. Example: {{company.brandColor}}.

Usage report

Fri, 21 Jun 2024 00:00:00 GMT

Track usage (and any overages) easier on Waypoint.

All of our subscription tiers come with a base set of emails included on each plan. For example, our starter plan includes 10,000 live emails sends. To help teams better track usage, we’ve added a simple report within the billing section on your workspace settings page.

Additionally, any overages are now automatically calculated and billed as part of your monthly invoice.

Note: If you are currently on a paid workspace and not seeing this, you should see it at the start of your next invoice cycle.

API endpoint: previewing templates

Thu, 23 May 2024 00:00:00 GMT

Teams can now preview a Waypoint email template via API. This is especially helpful for teams that want to show a preview of an email (within their platform) before sending through Waypoint. For example, an invoicing platform.

Use the new endpoint and optionally pass in custom data or with your template’s test data to get the processed HTML template as a response.

POST /v1/templates/TEMPLATE_ID/preview

Learn more in our API reference for template previewing.

Liquid currency filters

Tue, 14 May 2024 00:00:00 GMT

Display money values in your templates without the headaches. Teams can now convert numbers to formatted and localized currency strings with our new ‘currency’ Liquid templating filter.

Waypoint template builder using the new Liquid currency filter to format the variable output of 10.5 to $10.50 (defaults to USD).

Learn more about using Liquid templating on Waypoint.

Improved API request logs

Tue, 12 Mar 2024 00:00:00 GMT

To help devs monitor and debug Waypoint API requests, we’ve revamped our API requests troubleshooting page to include additional log information and permalinks to each request.