Homepage

EmailNotification

Last edit: Nov 10, 2026

Email template (app/emails): an email sent with the email_send mutation. Every
field except name and delay_by is Liquid, evaluated when the email is sent

type EmailNotification implements AdminSharedAttributesInterface {
  attachments: String
  bcc: String
  cc: String
  content: String
  created_at: JSONDate!
  delay_by: String
  form_configurations: [FormConfiguration!]
  forms: [Form!]
  from: String
  id: ID!
  layout: String
  layout_path: String
  manually_managed: Boolean
  metadata: HashObject
  name: String!
  physical_file_path: String
  reply_to: String
  subject: String
  to: String
  trigger_condition: String
  updated_at: JSONDate!
}

Fields

attachments (String)

Liquid that evaluates to a JSON object of attachments, mapping each file name
to its URL, for example { "file_name.jpg": { "url":
"https://example.com/file.jpg" } }

bcc (String)

Liquid that evaluates to a comma separated list of blind carbon copy
recipients, for example "[email protected], [email protected]"

cc (String)

Liquid that evaluates to a comma separated list of carbon copy recipients, for
example "[email protected], [email protected]"

content (String)

Liquid that evaluates to the HTML body of the email. The data argument of email_send is available in the data variable

created_at (JSONDate)

Timestamp of when the object was created, set automatically by the system

delay_by (String)

Number of minutes email_send waits before sending the email, given as a plain number, for example 60. Defaults to 0

form_configurations (FormConfiguration)

Deprecated, legacy forms that send this email

forms (Form)

Deprecated, legacy forms that send this email

from (String)

Liquid that evaluates to the sender address, for example [email protected]

id (ID)

Unique identifier of the object

layout (String)

Name of the layout the email content is rendered in, without the layouts/ prefix

layout_path (String)

Deprecated, use layout instead

manually_managed (Boolean)

When true, the resource is managed outside of files: pos-cli deploy and sync never overwrite or delete it

metadata (HashObject)

Free-form data attached to the resource with the metadata key of its file (or the metadata argument of an admin mutation)

name (String)

Name of the email, used to send it with the email_send mutation

physical_file_path (String)

Path of the file the resource comes from, relative to the app directory, for
example views/pages/index.liquid or
modules/my_module/public/views/partials/header.liquid. Identifies the resource
in deploy, sync and admin mutations

reply_to (String)

Liquid that evaluates to the address replies should go to, for example [email protected]

subject (String)

Liquid that evaluates to the subject of the email

to (String)

Liquid that evaluates to a comma separated list of recipients, for example "[email protected], [email protected]"

trigger_condition (String)

Liquid that evaluates to true (or t) when the email should be sent; any other result skips it. Defaults to true

updated_at (JSONDate)

Timestamp of when the object was last updated, set automatically by the system

Interfaces

AdminSharedAttributesInterface

Attributes shared by resources that can be deployed from files with pos-cli
(pages, partials, layouts, notifications, authorization policies, schemas, assets etc.)

Questions?

We are always happy to help with any questions you may have.

contact us