Prerequisites
What you need before sending emails with the Tuix Email Service.
Before sending an email you need:
- A Tuix account to access the dashboard.
- An Application ID and a Template UUID from the Tuix dashboard.
- An API key from the Tuix dashboard. See API Keys.
- The API base URL (see below).
Base URL
Set API_BASE_URL to the host of the environment you target:
| Environment | Base URL |
|---|---|
| Production | https://email-service.tuix.ch |
| Staging | https://staging-email-service.tuix.ch |
Finding your IDs
You need two IDs from the dashboard: an Application ID and a Template UUID.
Application ID
The Application ID identifies your application and is part of the send path
(/api/applications/{applicationId}/emails/send).
In the dashboard, open Applications: the Application ID column shows the ID, with a copy icon next to it.
Template UUID
The Template UUID identifies the template to send. Open an application's templates: the Template ID column shows the UUID, with a copy icon next to it.
Authentication
Authentication uses an API key, sent in the x-api-key header:
A private API key belongs on the server only, never expose it to the browser or ship it in client bundles. Only a key created as public may be used in the frontend. See API Keys.