Welcome
A sign-up welcome with a short greeting, one button to get started and the link written out underneath.
Magic link email template
Passwordless sign-in with one button and the link printed as text.
- From
- Northwind <[email protected]>
- Subject
- Your sign-in link for Northwind
- Preview text
- Your sign-in link for Northwind
Your sign-in link for {{productName}}
Sign in to {{productName}}
Use the button below to sign in. The link works once and expires in {{expiryMinutes}} minutes.
Sign in [{{actionUrl}}]
Or paste this into your browser: {{actionUrl}}
If you did not ask to sign in, you can ignore this. Nobody can use the link but you.
{{footerNote}}Shown with sample values. The HTML and plain-text tabs keep the placeholders.
About
When to send it
Send it when someone signs in without a password. The link works once and its expiry is stated up front, and printing it as text as well as on the button means it still works when the button does not.
Values
What each send fills in
Required values have to come with every send. The rest fall back to the default shown here.
| Placeholder | Kind | Required | Default |
|---|---|---|---|
{{productName}} | Text | Required | None |
{{actionUrl}} | Link | Required | None |
{{expiryMinutes}} | Text | Optional | 15 |
{{footerNote}} | Text | Optional | You are receiving this because somebody asked to sign in. |
API
Send it from your code
Create a template from this design once, then send it with the values for each message.
import { init, openemail } from '@openemail/sdk' init({ apiKey: process.env.OPENEMAIL_API_KEY }) const template = await openemail.templates.create({ name: 'Magic link', starter: 'magic-link', publish: true,}) const sent = await openemail.templates.send(template.slug, { from: 'Northwind <[email protected]>', to: '[email protected]', props: { productName: 'Northwind', actionUrl: 'https://example.com/sign-in/7d1f3a', },}) console.log(sent.id, sent.status)Accounts and access
More templates like this
Welcome card
A compact welcome in a card, with one button back into the product.
Verification code
A one-time code set large enough to read from another screen.
Password reset
A reset email with one button, a link to paste and a clear expiry.
Password reset card
A reset email that names the account and says plainly that nothing has changed yet.
Team invitation
An invitation that names the person inviting, the workspace and the role on offer.
New sign-in alert
A sign-in notice with the time, device and place, so people can recognise themselves.
Start from one
Pick a design, change anything,
and send it from your code.
Every template opens in the editor as blocks you can move, restyle or delete, and sends through the API with the values filled in.
