Skip to main content
The messages node is used to configure custom email notifications that are automatically triggered as soon as certain events or states occur in the shop. In addition to the system emails sent by default (e.g. order confirmation, shipping information or low-stock warning), individual emails can be defined here that are sent specifically to certain recipient groups — for example shop managers, suppliers or manufacturers. Important: not the email itself is integrated in the template, but the trigger for its dispatch. In the template the condition is checked via the template engine (e.g. “no search results found”). If it is met, the matching message is triggered for dispatch via its ID (e.g. order_confirmation). This function makes it possible to map shop-specific events that are relevant for the operation or logistics of a particular shop. New emails can currently only be created via the REST API configuration.

​
messages* - Basic structure

The basic structure of the messages node is shown below: 
{
  "messages": {
    "emails": {...}
  }
}
Parameter description
ParameterDescription
emailsConfigures system emails for the shop.

​
messages.emails - Event-driven emails

Configures system emails for the shop. Each configuration can be addressed via a unique ID and the template can be maintained differently per subshop.

​
Example configuration messages.emails.additionalMail

{
  "id": "order_confirmation",
  "sender": "shop@example.com",
  "subject": "Bestellbestätigung",
  "recipient": "customer@example.com",
  "template": "order_confirmation.htm"
}

​
Parameter overview

ParameterTypeDescription
idstringUnique identifier of the email configuration (e.g. order_confirmation).
Freely selectable.
The ID is used by the template to find the associated configuration.
recipientstringRecipient address of the email.
senderstringSender address of the email.
subjectstringSubject line of the email.
templatestringPath / name of the email template to be used (e.g. order_confirmation.htm).