The Send Email Hook replaces Zuvo's built-in email sending. You can use this hook to:
- Send emails using your own email provider
- Add internationalization or custom logic
- Fall back to another provider if your primary one fails
Inputs
| Field | Type | Description |
|---|---|---|
user | User | The user account taking the action |
email | object | Metadata specific to the email sending process |
{
"user": {
"id": "8484b834-f29e-4af2-bf42-80644d154f76",
"aud": "authenticated",
"role": "authenticated",
"email": "valid.email@supabase.io",
"phone": "",
"app_metadata": {
"provider": "email",
"providers": ["email"]
},
"user_metadata": {
"email": "valid.email@supabase.io",
"email_verified": false,
"phone_verified": false,
"sub": "8484b834-f29e-4af2-bf42-80644d154f76"
},
"identities": [
{
"identity_id": "bc26d70b-517d-4826-bce4-413a5ff257e7",
"id": "8484b834-f29e-4af2-bf42-80644d154f76",
"user_id": "8484b834-f29e-4af2-bf42-80644d154f76",
"identity_data": {
"email": "valid.email@supabase.io",
"email_verified": false,
"phone_verified": false,
"sub": "8484b834-f29e-4af2-bf42-80644d154f76"
},
"provider": "email",
"last_sign_in_at": "2024-05-14T12:56:33.824231484Z",
"created_at": "2024-05-14T12:56:33.824261Z",
"updated_at": "2024-05-14T12:56:33.824261Z",
"email": "valid.email@supabase.io"
}
],
"created_at": "2024-05-14T12:56:33.821567Z",
"updated_at": "2024-05-14T12:56:33.825595Z",
"is_anonymous": false
},
"email_data": {
"token": "305805",
"token_hash": "7d5b7b1964cf5d388340a7f04f1dbb5eeb6c7b52ef8270e1737a58d0",
"redirect_to": "http://localhost:3000/",
"email_action_type": "signup",
"site_url": "http://localhost:9999",
"token_new": "",
"token_hash_new": "",
"old_email": "",
"old_phone": "",
"provider": "",
"factor_type": ""
}
}
{
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"x-faker": "random.uuid"
},
"aud": {
"type": "string",
"enum": ["authenticated"]
},
"role": {
"type": "string",
"enum": ["anon", "authenticated"]
},
"email": {
"type": "string",
"x-faker": "internet.email"
},
"phone": {
"type": "string",
"x-faker": {
"fake": "{{phone.phoneNumber('+1##########')}}"
}
},
"app_metadata": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": ["email"]
},
"providers": {
"type": "array",
"items": {
"type": "string",
"enum": ["email"]
},
"minItems": 1,
"maxItems": 1
}
}
},
"user_metadata": {
"type": "object",
"properties": {
"email": {
"type": "string",
"x-faker": "internet.email"
},
"email_verified": {
"type": "boolean",
"x-faker": "random.boolean"
},
"phone_verified": {
"type": "boolean",
"x-faker": "random.boolean"
},
"sub": {
"type": "string",
"x-faker": "random.uuid"
}
}
},
"identities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity_id": {
"type": "string",
"x-faker": "random.uuid"
},
"id": {
"type": "string",
"x-faker": "random.uuid"
},
"user_id": {
"type": "string",
"x-faker": "random.uuid"
},
"identity_data": {
"type": "object",
"properties": {
"email": {
"type": "string",
"x-faker": "internet.email"
},
"email_verified": {
"type": "boolean",
"x-faker": "random.boolean"
},
"phone_verified": {
"type": "boolean",
"x-faker": "random.boolean"
},
"sub": {
"type": "string",
"x-faker": "random.uuid"
}
}
},
"provider": {
"type": "string",
"enum": ["email"]
},
"last_sign_in_at": {
"type": "string",
"format": "date-time",
"x-faker": "date.recent"
},
"created_at": {
"type": "string",
"format": "date-time",
"x-faker": "date.recent"
},
"updated_at": {
"type": "string",
"format": "date-time",
"x-faker": "date.recent"
},
"email": {
"type": "string",
"x-faker": "internet.email"
}
},
"required": [
"identity_id",
"id",
"user_id",
"identity_data",
"provider",
"last_sign_in_at",
"created_at",
"updated_at",
"email"
]
}
},
"created_at": {
"type": "string",
"format": "date-time",
"x-faker": "date.recent"
},
"updated_at": {
"type": "string",
"format": "date-time",
"x-faker": "date.recent"
},
"is_anonymous": {
"type": "boolean",
"x-faker": "random.boolean"
}
},
"required": [
"id",
"aud",
"role",
"email",
"phone",
"app_metadata",
"user_metadata",
"identities",
"created_at",
"updated_at",
"is_anonymous"
]
},
"email_data": {
"type": "object",
"properties": {
"token": {
"type": "string",
"pattern": "^[0-9]{6}$",
"x-faker": {
"fake": "{{helpers.replaceSymbols('######')}}"
}
},
"token_hash": {
"type": "string",
"minLength": 16,
"maxLength": 30,
"x-faker": {
"fake": "{{random.alphaNumeric(30)}}"
}
},
"redirect_to": {
"type": "string",
"x-faker": "internet.url"
},
"email_action_type": {
"type": "string",
"enum": [
"signup",
"invite",
"magiclink",
"recovery",
"email_change",
"email",
"reauthentication",
"password_changed_notification",
"email_changed_notification",
"phone_changed_notification",
"identity_linked_notification",
"identity_unlinked_notification",
"mfa_factor_enrolled_notification",
"mfa_factor_unenrolled_notification"
]
},
"site_url": {
"type": "string",
"x-faker": "internet.url"
},
"token_new": {
"type": "string",
"minLength": 16,
"maxLength": 30,
"x-faker": {
"fake": "{{random.alphaNumeric(30)}}"
}
},
"token_hash_new": {
"type": "string",
"minLength": 16,
"maxLength": 30,
"x-faker": {
"fake": "{{random.alphaNumeric(30)}}"
}
},
"old_email": {
"type": "string",
"x-faker": "internet.email"
},
"old_phone": {
"type": "string",
"x-faker": {
"fake": "{{phone.phoneNumber('+1##########')}}"
}
},
"provider": {
"type": "string",
"enum": ["email"]
},
"factor_type": {
"type": "string",
"enum": ["totp"]
}
},
"required": [
"token",
"token_hash",
"redirect_to",
"email_action_type",
"site_url",
"token_new",
"token_hash_new"
]
}
},
"required": ["user", "email_data"]
}
Outputs
- No outputs are required. An empty response with a status code of 200 is taken as a successful response.
Email sending behavior
Email sending depends on two settings: Email Provider and Auth Hook status.
| Email Provider | Auth Hook | Result |
|---|---|---|
| Enabled | Enabled | Auth Hook handles email sending (SMTP not used) |
| Enabled | Disabled | SMTP handles email sending (custom if configured, default otherwise) |
| Disabled | Enabled | Email signups disabled |
| Disabled | Disabled | Email signups disabled |
Email change behavior and token hash mapping
When email_action_type is email_change, the hook payload can include one or two OTPs and their hashes. This depends on your Secure Email Change setting.
- Secure Email Change enabled: two OTPs are generated, one for the current email (
user.email) and one for the new email (user.new_email). You must send two emails. - Secure Email Change disabled: only one OTP is generated for the new email. You send a single email.
What to send
When Secure Email Change is enabled (both token/hash pairs present):
- Send to current email address (
user.email): usetokenwithtoken_hash_new - Send to new email address (
user.new_email): usetoken_newwithtoken_hash
When Secure Email Change is disabled (only one token/hash pair present):
- Send a single email to the new email address. Use
tokenwithtoken_hashortoken_newwithtoken_hash, depending on which fields are present in the payload.
Your company uses a worker to manage all emails related jobs. For performance reasons, the messaging system sends emails in batches via a job queue. Instead of sending a message immediately, messages are queued and sent in periodic intervals via pg_cron.
Create a table to store jobs
create table job_queue (
job_id uuid primary key default gen_random_uuid(),
job_data jsonb not null,
created_at timestamp default now(),
status text default 'pending',
priority int default 0,
retry_count int default 0,
max_retries int default 2,
scheduled_at timestamp default now()
);
Create the hook
create or replace function send_email(event jsonb) returns jsonb as $$
declare
job_data jsonb;
scheduled_time timestamp;
priority int;
begin
-- Extract email details from the event JSON
job_data := jsonb_build_object(
'email_action_type', event->'email_data'->>'email_action_type',
'token_hash', event->'email_data'->>'token_hash',
'token', event->'email_data'->>'token',
'email', event->'user'->>'email'
);
-- Calculate the nearest 5-minute window for scheduled_time
scheduled_time := date_trunc('minute', now()) + interval '5 minute' * floor(extract('epoch' from (now() - date_trunc('minute', now())) / 60) / 5);
-- Assign priority dynamically (example logic: higher priority for earlier scheduled time)
priority := extract('epoch' from (scheduled_time - now()))::int;
insert into public.job_queue (job_data, priority, scheduled_at, max_retries)
values (job_data, priority, scheduled_time, 2);
return '\{\}'::jsonb;
end;
$$ language plpgsql;
grant all
on table public.job_queue
to supabase_auth_admin;
revoke all
on table public.job_queue
from authenticated, anon;
Create a function to periodically run and dequeue all jobs
create or replace function dequeue_and_run_jobs() returns void as $$
declare
job record;
begin
for job in
select * from job_queue
where status = 'pending'
and scheduled_at <= now()
order by priority desc, created_at
for update skip locked
loop
begin
-- add job processing logic here.
-- for demonstration, we'll just update the job status to 'completed'.
update job_queue
set status = 'completed'
where job_id = job.job_id;
exception when others then
-- handle job failure and retry logic
if job.retry_count < job.max_retries then
update job_queue
set retry_count = retry_count + 1,
scheduled_at = now() + interval '1 minute' -- delay retry by 1 minute
where job_id = job.job_id;
else
update job_queue
set status = 'failed'
where job_id = job.job_id;
end if;
end;
end loop;
end;
$$ language plpgsql;
grant execute
on function public.dequeue_and_run_jobs
to supabase_auth_admin;
revoke execute
on function public.dequeue_and_run_jobs
from authenticated, anon;
Configure pg_cron to run the job on an interval. You can use a tool like crontab.guru to check that your job is running on an appropriate schedule. Ensure that pg_cron is enabled under Database > Extensions
select
cron.schedule(
'* * * * *', -- this cron expression means every minute.
'select dequeue_and_run_jobs();'
);
You can configure Resend as the custom email provider through the "Send Email" hook. This allows you to take advantage of Resend's developer-friendly APIs to send emails and leverage React Email for managing your email templates. For a more advanced React Email tutorial, refer to this guide.
If you want to send emails through the Zuvo Resend integration, which uses Resend's SMTP server, check out this integration instead.
Create a .env file with the following environment variables:
RESEND_API_KEY="your_resend_api_key"
SEND_EMAIL_HOOK_SECRET="v1,whsec_<base64_secret>"
Set the secrets in your Zuvo project:
supabase secrets set --env-file .env
Create a new edge function:
supabase functions new send-email
Add the following code to your edge function:
import { Webhook } from "https://esm.sh/standardwebhooks@1.0.0";
import { Resend } from "npm:resend";
const resend = new Resend(Deno.env.get("RESEND_API_KEY") as string);
const hookSecret = (Deno.env.get("SEND_EMAIL_HOOK_SECRET") as string).replace("v1,whsec_", "");
Deno.serve(async (req) => {
if (req.method !== "POST") {
return new Response("not allowed", { status: 400 });
}
const payload = await req.text();
const headers = Object.fromEntries(req.headers);
const wh = new Webhook(hookSecret);
try {
const { user, email_data } = wh.verify(payload, headers) as {
user: {
email: string;
};
email_data: {
token: string;
token_hash: string;
redirect_to: string;
email_action_type: string;
site_url: string;
token_new: string;
token_hash_new: string;
};
};
const { error } = await resend.emails.send({
from: "welcome <onboarding@example.com>",
to: [user.email],
subject: "Welcome to my site!",
text: `Confirm you signup with this code: ${email_data.token}`,
});
if (error) {
throw error;
}
} catch (error) {
return new Response(
JSON.stringify({
error: {
http_code: error.code,
message: error.message,
},
}),
{
status: 401,
headers: { "Content-Type": "application/json" },
},
);
}
const responseHeaders = new Headers();
responseHeaders.set("Content-Type", "application/json");
return new Response(JSON.stringify({}), {
status: 200,
headers: responseHeaders,
});
});
Deploy your edge function and configure it as a hook:
supabase functions deploy send-email --no-verify-jwt
Your company is expanding to France and Spain. As part of expansion efforts, the company would like to deliver internationalized email templates to best support local users in their native language. Ensure that you have configured POSTMARK_SERVER_TOKEN and SEND_EMAIL_HOOK_SECRET in your .env file.
import { readAll } from 'https://deno.land/std/io/read_all.ts'
import { Webhook } from 'https://esm.sh/standardwebhooks@1.0.0'
const postmarkEndpoint = 'https://api.postmarkapp.com/email'
// Replace this with your email
const FROM_EMAIL = 'myemail@gmail.com'
const PROJECT_REF = '<your-project-ref>'
// Email Subjects
const subjects = {
en: {
signup: 'Confirm your email address',
recovery: 'Reset your password',
invite: "You've been invited",
magiclink: 'Your sign-in link',
email_change: 'Confirm your new email address',
email_change_new: 'Confirm your new email address',
reauthentication: '{{token}} is your verification code',
},
es: {
signup: 'Confirma tu correo electrónico',
recovery: 'Restablece tu contraseña',
invite: 'Has sido invitado',
magiclink: 'Tu enlace de inicio de sesión',
email_change: 'Confirma tu nueva dirección de correo electrónico',
email_change_new: 'Confirma tu nueva dirección de correo electrónico',
reauthentication: '{{token}} es tu código de verificación',
},
fr: {
signup: 'Confirmez votre adresse e-mail',
recovery: 'Réinitialisez votre mot de passe',
invite: 'Vous avez été invité',
magiclink: 'Votre lien de connexion',
email_change: 'Confirmez votre nouvelle adresse e-mail',
email_change_new: 'Confirmez la nouvelle adresse e-mail',
reauthentication: '{{token}} est votre code de vérification',
},
}
// HTML Body
const templates = {
en: {
signup: `<h2>Confirm your email address</h2><p>Follow the link below to confirm this email address and finish signing up.</p><p><a href="{{confirmation_url}}">Confirm email address</a></p>`,
recovery: `<h2>Reset your password</h2><p>We received a request to reset your password. Follow the link below to choose a new one.</p><p><a href="{{confirmation_url}}">Reset password</a></p><p>If you didn't request this, you can safely ignore this email.</p>`,
invite: `<h2>You've been invited</h2><p>You've been invited to create an account. Follow the link below to accept.</p><p><a href="{{confirmation_url}}">Accept invitation</a></p>`,
magiclink: `<h2>Your sign-in link</h2><p>Follow the link below to sign in. This link expires shortly and can only be used once.</p><p><a href="{{confirmation_url}}">Sign in</a></p>`,
email_change: `<h2>Confirm your new email address</h2><p>Follow the link below to confirm {{new_email}} as your new email address.</p><p><a href="{{confirmation_url}}">Confirm new email address</a></p><p>If you didn't request this change, you can safely ignore this email.</p>`,
email_change_new: `<h2>Confirm your new email address</h2><p>Follow the link below to confirm {{new_email}} as your new email address.</p><p><a href="{{confirmation_url}}">Confirm new email address</a></p><p>If you didn't request this change, you can safely ignore this email.</p>`,
reauthentication: `<h2>Your verification code</h2><p>Use the code below to verify your identity. It expires shortly.</p><p>{{token}}</p>`,
},
es: {
signup: `<h2>Confirma tu dirección de correo electrónico</h2><p>Sigue el enlace de abajo para confirmar esta dirección de correo electrónico y terminar el registro.</p><p><a href="{{confirmation_url}}">Confirmar dirección de correo electrónico</a></p>`,
recovery: `<h2>Restablece tu contraseña</h2><p>Recibimos una solicitud para restablecer tu contraseña. Sigue el enlace de abajo para elegir una nueva.</p><p><a href="{{confirmation_url}}">Restablecer contraseña</a></p><p>Si no solicitaste esto, puedes ignorar este correo.</p>`,
invite: `<h2>Has sido invitado</h2><p>Te han invitado a crear una cuenta. Sigue el enlace de abajo para aceptar.</p><p><a href="{{confirmation_url}}">Aceptar invitación</a></p>`,
magiclink: `<h2>Tu enlace de inicio de sesión</h2><p>Sigue el enlace de abajo para iniciar sesión. Este enlace caduca pronto y solo se puede usar una vez.</p><p><a href="{{confirmation_url}}">Iniciar sesión</a></p>`,
email_change: `<h2>Confirma tu nueva dirección de correo electrónico</h2><p>Sigue el enlace de abajo para confirmar {{new_email}} como tu nueva dirección de correo electrónico.</p><p><a href="{{confirmation_url}}">Confirmar nueva dirección de correo electrónico</a></p><p>Si no solicitaste este cambio, puedes ignorar este correo.</p>`,
email_change_new: `<h2>Confirma tu nueva dirección de correo electrónico</h2><p>Sigue el enlace de abajo para confirmar {{new_email}} como tu nueva dirección de correo electrónico.</p><p><a href="{{confirmation_url}}">Confirmar nueva dirección de correo electrónico</a></p><p>Si no solicitaste este cambio, puedes ignorar este correo.</p>`,
reauthentication: `<h2>Tu código de verificación</h2><p>Usa el código de abajo para verificar tu identidad. Caduca pronto.</p><p>{{token}}</p>`,
},
fr: {
signup: `<h2>Confirmez votre adresse e-mail</h2><p>Suivez le lien ci-dessous pour confirmer cette adresse e-mail et terminer votre inscription.</p><p><a href="{{confirmation_url}}">Confirmer l'adresse e-mail</a></p>`,
recovery: `<h2>Réinitialisez votre mot de passe</h2><p>Nous avons reçu une demande de réinitialisation de votre mot de passe. Suivez le lien ci-dessous pour en choisir un nouveau.</p><p><a href="{{confirmation_url}}">Réinitialiser le mot de passe</a></p><p>Si vous n'avez pas fait cette demande, vous pouvez ignorer cet e-mail.</p>`,
invite: `<h2>Vous avez été invité</h2><p>Vous avez été invité à créer un compte. Suivez le lien ci-dessous pour accepter.</p><p><a href="{{confirmation_url}}">Accepter l'invitation</a></p>`,
magiclink: `<h2>Votre lien de connexion</h2><p>Suivez le lien ci-dessous pour vous connecter. Ce lien expire bientôt et ne peut être utilisé qu'une seule fois.</p><p><a href="{{confirmation_url}}">Se connecter</a></p>`,
email_change: `<h2>Confirmez votre nouvelle adresse e-mail</h2><p>Suivez le lien ci-dessous pour confirmer {{new_email}} comme nouvelle adresse e-mail.</p><p><a href="{{confirmation_url}}">Confirmer la nouvelle adresse e-mail</a></p><p>Si vous n'avez pas demandé ce changement, vous pouvez ignorer cet e-mail.</p>`,
email_change_new: `<h2>Confirmez votre nouvelle adresse e-mail</h2><p>Suivez le lien ci-dessous pour confirmer {{new_email}} comme nouvelle adresse e-mail.</p><p><a href="{{confirmation_url}}">Confirmer la nouvelle adresse e-mail</a></p><p>Si vous n'avez pas demandé ce changement, vous pouvez ignorer cet e-mail.</p>`,
reauthentication: `<h2>Votre code de vérification</h2><p>Utilisez le code ci-dessous pour vérifier votre identité. Il expire bientôt.</p><p>{{token}}</p>`,
},
}
function generateConfirmationURL(email_data) {
const baseUrl = `https://${PROJECT_REF}.supabase.co/auth/v1/verify`
const params = new URLSearchParams({
token: email_data.token_hash,
type: email_data.email_action_type,
redirect_to: email_data.redirect_to,
})
return `${baseUrl}?${params.toString()}`
}
Deno.serve(async (req) => {
const payload = await req.text()
const serverToken = Deno.env.get('POSTMARK_SERVER_TOKEN')
const headers = Object.fromEntries(req.headers)
const base64_secret = Deno.env.get('SEND_EMAIL_HOOK_SECRET').replace('v1,whsec_', '')
const wh = new Webhook(base64_secret)
const { user, email_data } = wh.verify(payload, headers)
const language = (user.user_metadata && user.user_metadata.i18n) || 'en'
const subject = subjects[language][email_data.email_action_type] || 'Notification'
let template = templates[language][email_data.email_action_type]
const confirmation_url = generateConfirmationURL(email_data)
let htmlBody = template
.replace('{{confirmation_url}}', confirmation_url)
.replace('{{token}}', email_data.token || '')
.replace('{{new_token}}', email_data.new_token || '')
.replace('{{site_url}}', email_data.site_url || '')
.replace('{{old_email}}', email_data.old_email || '')
.replace('{{new_email}}', user.new_email || '')
const requestOptions = {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Accept: 'application/json',
'X-Postmark-Server-Token': serverToken,
},
body: JSON.stringify({
From: FROM_EMAIL,
To: user.email,
Subject: subject,
HtmlBody: htmlBody,
}),
}
try {
const response = await fetch(postmarkEndpoint, requestOptions)
if (!response.ok) {
const errorData = await response.json()
throw new Error(`Failed to send email: ${errorData.Message}`)
}
return new Response(
JSON.stringify({
message: 'Email sent successfully.',
}),
{
headers: {
'Content-Type': 'application/json',
},
}
)
} catch (error) {
return new Response(
JSON.stringify({
error: `Failed to process the request: ${error.message}`,
}),
{
status: 500,
headers: {
'Content-Type': 'application/json',
},
}
)
}
})