Skip to Content
Docs

Sending email

Email contacts about replies they have not read and changes to their tickets, through SMTP or Resend.

Email is off until a provider is set. It covers what Helpwren itself sends; team members' sign-in codes are sent by Supabase Auth, set up separately (see Configure Auth).

Before you start

  • An SMTP server, or a Resend account with a verified domain.
  • The scheduled jobs running: the email job sends what is due.

Set it up

  1. Add the provider to the app's environment and restart or redeploy it:

    apps/web/.env.local
    # Any SMTP server
    EMAIL_PROVIDER=smtp
    SMTP_URL=smtps://user:password@smtp.example.com:465
    
    # Or Resend
    EMAIL_PROVIDER=resend
    RESEND_API_KEY=re_...

    With Docker Compose, set EMAIL_PROVIDER and HELPWREN_SMTP_URL (or RESEND_API_KEY) in deploy/docker/.env, then run docker compose up --detach helpwren.

  2. In Settings → Email, set the From address, on a domain your provider lets you send from, and optionally a From name. Without one, your brand's name is used.

  3. Under Try it, send a test email to yourself.

  4. Choose what contacts are sent, under To your contacts.

SettingSends
Replies they have not readYour team's reply, five minutes later, if the contact has not read it in the chat
Changes to a ticket's statusA note when your team resolves, reopens or parks one of their tickets

Contacts are emailed only when they have an email address: one they typed, or one your product passed when signing them in.

Change what the emails say

Every email is in your brand: your logo, your button colour and your name, from Settings → Branding. Its words are yours to change in Settings → Email templates, one tab per email:

TemplateSent when
Chat replyA contact has not read your team's reply in the chat
Ticket replyA contact has not read your team's reply on their ticket
Ticket statusYour team changes the status of a contact's ticket

Each has a subject, a heading, a message and a button. A field left empty uses Helpwren's wording, which is shown in it, and Reset to default empties all four. A blank line in the message starts a new paragraph. The preview beside the form shows the email with made-up details, and Send me a test sends it to you as it reads, before you save.

These placeholders are filled in for the contact each email goes to:

PlaceholderBecomes
{{brand}}Your brand name
{{name}}The contact's first name, or "there"
{{ticket}}The ticket's number and subject
{{replies}}"a new reply" or "3 new replies"
{{status}}The ticket's new status, such as "Resolved"

The replies themselves, the line saying the contact can answer by email, and the small print saying why they got the email are always added, so every email still makes sense whatever it says.

Let contacts reply

Each email can carry a reply address, so a contact answers from their mail app and the answer lands in the same conversation. See Replies by email.