Types of templates
Types of templates
There are two kinds of templates: EmailTemplates and DocumentTemplates.
Both template share a couple of field, namely:
| Field | Description |
|---|---|
| ID | The ID if the template, UUID v7 format |
| Names | The display name of the template, per given language |
| Contents | A handlebars template which outputs the html for the template, per given language |
| Custom Query | A custom graphql query that you can use to enrich the event payload data |
| Query variables | Variables used to execute the custom query, supports handlebars variables. The final result after rendering with handlebars should be a valid json. This is the only handlebars field that's rendered only with the original event payload. Any other field with handlebars support, also includes the data fetched by the custom query |
EmailTemplates
Email templates are used to send out an email based on the given event payload, and can be linked directly to an Event Action
Email templates include additional fields needed to send out emails.
| Field | Description |
|---|---|
| Subject | The subject of the emails to send out, per given language. Supports use of handlebars variables. |
| From | The sender of the email. Consists of 2 fields, an email address and a name the name can be translated into multiple languages |
| Tos | An array of EmailContacts |
| Ccs | An array of EmailContacts |
| Bccs | An array of EmailContacts |
| Attachments | An array of document templates that will be rendered and send as attached PDF with the email |
EmailContact
| Field | Description |
|---|---|
| The email address of the contact, this fields supports handlebars variables | |
| Name | (optional) The display name of the contact, this fields supports handlebars variables |
DocumentTemplates
Document templates are used to generate PDF documents based on the given event payload. The can be added to an EmailTemplate as attachment, or can be generated from dedicated mutations, like getOrderPDF and getQuotePDF, these methods select the documentTemplate with isDefaultOrderPdf or isDefaultQuotePdf resp.
| Field | Description |
|---|---|
| FileNames | The proposed file name for the generated PDF document, per given language. Will be used for the file name when attached to an EmailTemplate, can be use in the Content-Disposition header when loading the template in the frontend |
| isDefaultOrderPdf | Indicates this template will be used when generating a order PDF in the Propeller Backoffice or when calling the orderGetPDF mutation in the API |
| isDefaultQuotePdf | Indicates this template will be used when generating a quote PDF in the Propeller Backoffice or when calling the quoteGetPDF mutation in the API |