Skip to main content

Cyware Orchestrate

Email Templates

What are email templates?

Email templates are pre-defined email layouts in rich text format that include an email header and body. Analysts can reuse these templates with predefined content and customize them in playbooks, streamlining email creation and reducing manual effort. This also eliminates the need for technical expertise to configure custom nodes for emails.

How can I use email templates?

Analysts can use the templates in playbooks to send emails. The templates can be used for apps that support Rich Text format field type. For example, you can use email templates in Cyware Email Service - Send Email in Rich Text Format.

You can perform the following actions with email templates:

Create Email Template

You can create and reuse email templates to send emails to recipients. You can create a maximum of 20 email templates.

Before you start

Ensure that your user group has permission to Create/Update Email Template.

Steps

To create an email template, follow these steps:

  1. Go to Playbooks > Resource Library and select Email Templates.

  2. Click Create Template and enter the following details:

    • Title: Enter the title for the email template.

    • Description: Enter a brief description for the email template.

    • Template Body: In the Template Body, you can format the email body using options like bold, italics, tables, and an HTML editor. You can also define variables in the {{variable}} format, which will be automatically replaced with actual values when the email is sent. For example, {{incident_id}} will be replaced with the specific incident

  3. Click Save.

Note

Updating an email template will not affect playbooks that have already used it. The updated template will only apply to playbooks that use it after the changes are made.

Use Email Template in Playbook

You can use the created email templates in playbooks and further customize them using the rich text editor.

Steps

To use an email template in the playbook, follow these steps:

  1. Go to an existing playbook or create a new playbook. For more information, see Create Playbook.

  2. Drag and drop an app node, search, and select the required app that supports rich text fields. For example, search for Cyware Email Service and select Send Email in Rich Text Format.

  3. Click the added node and select Input Data. Move through the options to find the Message Body field.

  4. Click Select Template, choose the email template you created. The following is an example email template with a variable incident_id. In this example, the variable should automatically take the unique ID of the incident onboarded by the playbook.

    Notice

    Hi user,

    The Incident Onboarding and Action playbook automatically onboarded suspicious activity from your SIEM to Respond as an incident. The unique ID of the newly onboarded incident is {{incident_id}}.

  5. You can choose to preview an email template before restoring it. To preview and use an email template, click Preview > Use Template. 

  6. Click Sync Variables to fetch the variables from the email body as keys. This converts variables into key-value pairs. You can assign a static value or a dynamic path as values. The below example shows a dynamic path assigned to the incident_id key to automatically fetch the unique ID of the incident onboarded by the playbook.

    key: incident_id 
value: ${_2::result::cftr_instance::incident_id}

    The ${_2::result::cftr_instance::incident_id} dynamic path retrieves the unique incident ID from the results of node number 2.

  7. You can modify or customize the template as required.

Manage Email Templates

You can perform the following actions to manage email templates in Playbooks > Resource Library > Email Templates:

  • Search: You can search for an email template using the search bar.

  • Edit: You can edit the details of an email template by clicking the Edit icon.

  • Delete: You can delete email templates that are not in use.

    Note

    To delete an email template, ensure your user group has permission to Delete Email Template.