Circuit Email State | Qntrl Online Help | Circuit Online Help | Automate Email Notifications in Circuits

Email

The Email state lets you automate email notifications as part of your workflow, eliminating the need for manual intervention. This state is available under the Notifications category in Builder View.

Use Case  
In an employee asset allocation circuit, after a license key is activated using a Function state, the Email state can automatically send a notification to the employee and IT team. This email can include details like the software name, license key, and activation date, helping keep everyone informed without manual effort.
 
Prerequisite  
To use this state, an email template with Type set as "Circuit" must be created in the Email Templates module. Only templates created for Circuits will be listed during configuration. Refer to the Email Templates Help Page for guidance on creating and managing Circuit-specific templates.

Builder View 

For associating the state in Builder View:
  • Drag and drop the Email state from the Notifications section in the left pane of Builder View.
  • Select the state and open the Configuration pane. Update the common state field attributes.
  • From the Email Templates dropdown, select a template associated with the circuit.
Under the Add Configuration section, provide the following fields. You can either enter recipient details manually or use JSON paths to assign them dynamically. Note that all recipients must be verified users within your organization.
  1. To / To Recipients Path  
    • To: Manually enter one or more recipient email addresses, separated by commas.
    • To Recipients Path: If recipients need to be set dynamically, specify their email addresses using a JSON path (e.g., $.email).
  2. CC / CC Recipients Path  
    • CC: Manually enter the CC email addresses, separated by commas.
    • CC Recipients Path: Use a JSON path to assign CC recipients dynamically.
  3. BCC / BCC Recipients Path  
    • BCC: Manually enter the BCC email addresses, separated by commas.
    • BCC Recipients Path: Provide a JSON path to dynamically specify BCC recipients.
  4. Files / Files Path  
    • Files: Select files from the dropdown list, which shows files from the Qntrl Files module.
    • Files Path: Enter a file path manually if you're passing files through input JSON.
  5. On Failure  : Choose how the Circuit should behave if TransMail fails(e.g., delay or delivery issue). This setting does not handle validation failures like invalid email and will cause the state and circuit to fail
    • Continue: Proceed to the next state even if the email fails.
    • Stop: Stop circuit execution if email delivery fails.
  6. Custom Data  : Custom placeholders from the email template appear here for mapping dynamic values from the circuit input(e.g., dynamic placeholders like due dates, usernames, etc.).

Notes
  • The combined size of all files (from both templates and configuration) must not exceed 14 MB.

  • If one of the recipient emails is incorrect, the entire email will fail to send.


Limitations  
  • To, CC, and BCC: Max 10 recipients each.
  • Files: Max 3 files.
 

Code View 

In Code View, the JSON to execute a Task Engine state is given below.

{
"Licence Key Activation Notification": {
"type": "email",
"next": "End",
"email_template_id": "notification_email_12",
"payload": {
"on_failure": "continue",
"to": [
],
"files": [
"employee logs.xml",
"license_key_config.json"
],
"bcc": [
],
"cc_recipients_path": "$.cc_mails"
},
"start": true,
"parameters": {
"Date": "07.07.2025"
}
}
}

 

Troubleshooting   

1. Can I use an email template created for Boards in a Circuit?

No. Only templates created with Type: Circuit are supported in the Email Template state. Board-type templates will not appear in the selection dropdown and are not compatible.

2. Why did my email notification fail even though the configuration seems correct?

If one or more recipients in the To, CC, or BCC fields are invalid or deleted users, the entire email fails to send, and the state execution fails.

3. Why did the circuit continue after the email state failed?

This happens when the On Failure setting is configured to Continue. In this case, even if the notification fails (e.g., due to issues with TransMail), the circuit moves to the next state instead of stopping.

4. Why are my attached files not being delivered in the email?

The total file size (including those attached in the email template and additional files configured in the state) must not exceed 14MB. If it does, the email will not be sent.

5. Why can't I find the email template I created in the dropdown?

Ensure that the email template was created with Type: Circuit. Only templates of this type are available for use in the Email Template state.

6. Can I attach files from both the Email Templates attachments and the Email state file configuration?

Yes, you can attach files from both the sources, but the combined size of all files attached (from both the template and configuration) must stay within the 14MB limit.





    • Related Articles

    • Email In

      Anyone can now easily add cards to boards by just sending emails using Email In. Email In comes in handy when you are not logged into Qntrl but still want to perform card-related operations. Here, each board will have a unique Email In ID to which ...
    • Send Email

      Automated emails allow for comprehensive communication in today’s organizations. Use them to inform your team about the progress of a card or notify specific users when the card moves to the next stage. Configure automated emails by choosing an email ...
    • Customize Email Templates

      Overview of email templates Communication is key in any organization. It often becomes a challenge to track the myriad of ongoing tasks in a huge team. Qntrl helps your team overcome this challenge and stay informed via notifications and emails. ...
    • White Labeling

      Early Access White Labeling for Qntrl is not enabled for all users. If you'd like to try it out, please email our support team for early access. White Label allows organizations to completely rebrand Qntrl to reflect their organization’s brand ...
    • Preferences

      Manage your organization details in the Preferences section. You can choose to configure your organizational preferences, such as organization name, owner, URL, date and time settings, and email domain here. Access Privilege Preferences can be ...

    You are currently viewing the help articles of Qntrl 3.0. If you are still using our older version and require guidance with it, Click here.