Getting started with transactional email

How it works

To send a transactional message, connect through the API or use one of the supported integrations. Requests are accepted after the destination address and API key are verified.

Send your first transactional email

Begin by creating a transactional template from the workspace.

Compose your email

Use the builder

Select the reset button to configure its destination. A secure destination path will be included in the request payload.

Bring your own markup

You can also upload HTML directly from your own build system. Review unsupported tags before submitting a new version.

curl --request POST /v1/transactional/templates
--header "Authorization: Bearer $TOKEN"

Review your email

Check template variables, sender identity, preview text, and test delivery from the review screen before publishing.

Publish the email

A template must be published before it can be used in production. Publishing creates a stable version while preserving your editable draft.

Send the email

Submit the request with your recipient, template identifier, and any required values. API keys remain private and should never be included in client-side code.

POST /v1/transactional/send

{
  "templateId": "reset-password-v3",
  "recipient": "member@example.test",
  "dataVariables": { "resetPath": "/account/reset" }
}

Edit an email

Duplicate the live version as a draft, make changes in the builder, and republish when the new version is ready.

Metrics

Delivery events appear on the metrics page, including accepted requests, delivered messages, opens, and permanent bounces.