Skip to main content

Create a template

Goal​

To create a new template in the Propeller backoffice that can be used to send emails or generate PDF documents. Templates are used for communication and documentation triggered by system events like order updates, quote sends or password resets.

Step 1: Navigate to the Templates Section​

  1. In the backoffice menu, go to Admin and select Templates.
  2. The Templates overview displays all existing templates with their ID, Name, Type (Email or Document), and the creation or modification date.

Step 2: Click ‘Create Template’​

  1. At the top right, click the Create Email Template or Create Document Template button depending on what you want to create.
  2. Tabs appear based on the selected type:
  • For Email Templates: tabs include General, Email and Attachments.
  • For Document Templates: tabs include General and Document.

Step 3: Fill in General Template Information​

  1. In the General tab:

  • Name: Enter a clear, descriptive name for the template (e.g., “Order confirmation email” or “Quote PDF”).

  • Content: Add the email body or PDF layout using HTML with Handlebars placeholders.

  • Custom query (optional): Use a GraphQL query if you need extra data not present in the default event (e.g., user info, product images).

  • Query variables (optional): Define variables for the custom query using handlebars, like:

    { "login": "{{data.contact.email}}" }

Step 4: Add Email-Specific Details (for Email Templates Only)​

  1. Switch to the Email tab:
  • Subject: Enter a subject line for the email.
  • From:
    • Email: Add the sender's email address.
    • Name: Add a display name for the sender.
  • To / CC / BCC:
    • Add email recipients directly or use dynamic values.

Step 5: Attach PDF Documents (for Email Templates Only)​

  1. Go to the Attachments tab:
  • Link one or more existing DocumentTemplates to attach them as PDFs to the outgoing email.
  • For example, attach a quote PDF to a quote confirmation email.

Step 6: Set Document Settings (for Document Templates Only)​

  1. If you're creating a Document Template, scroll down to the Document tab:
  • File name: Define the name for the generated PDF file.
  • Enable:
    • Default Order PDF: if this is the default file for order PDF's created in front-end and Propeller Sales Portal.
    • Default Quote PDF: if this should be used for generating quote PDF's in front-end and Propeller Sales Portal.

Step 7: Save the Template​

  • Click Save in the top right corner.
  • The template is now available in the Templates overview and can be linked to event actions or triggered via the API.

Best Practices​

  • Naming: Use consistent naming (e.g., “Order confirmation email”) to easily identify templates by type.
  • Languages: Ensure to set up the content and namings for all relevant languages. Each field that is translatable has a language indicator (e.g. NL).
  • Test before linking: Use the API to preview emails or documents before connecting them to live events.
  • Re-use components: Share document templates across multiple email templates if the PDF content is the same.
  • Personalize when needed: Use custom queries to fetch additional data for personalization.
  • Avoid errors: Make sure your handlebars code renders correctly by testing the template with real data.