This is the multi-page printable view of this section. Click here to print.
Notification Steps
1 - Notify Distribution Group
Description
Send an email notification to a PlaidCloud distribution group. Messages are sent from info@tartansolutions.com. No outbound setup is required.
Select PlaidCloud Distribution List
Select a single distribution list from the drop down menu. Distribution lists can be created using Tools. For details on creating a distribution list, see here: PlaidCloud Tools – Distro.
Message
Specify Subject and Body as desired.
Please note that both Project Variables and Workflow Variables are available for use with this transform, in both the subject line and the message body.
Additionally, standard HTML code is permitted in the body to further customize the look of the email messages.
Examples
In this example, all of the system variables are used. Additionally, there is a small bit of HTML used to format the first line of the body. Executing this transform will send the following email to all members specified in the distribution group:
- FROM: info@tartansolutions.com (remember that all messages come from this address)
- Subject: DEMO Analyze Demo Running
2 - Notify Agent
Description
Notify a PlaidCloud Agent.
Examples
No examples yet...
3 - Notify Via Email
Description
Send email notifications. Messages are sent from info@tartansolutions.com email account. No outbound setup is required.
Email Addresses
Specify any number of email recipients. Acceptable delimiters include semicolon (;) and comma (,).
Message
Specify Subject and Body as desired.
Please note that both Project Variables and Workflow Variables are available for use with this transform, in both the subject line and the message body.
Additionally, standard HTML code is permitted in the body to further customize the look of the email messages.
Attachments
Attaching files to emails is very simple. Select a file or folder from Document to attach. If a folder is selected, the contents of the folder will be attached as individual files. Variable substitution works with paths for better control of file attachments when sending out personalized emails.
Examples
In this example, all of the system variables are used. Additionally, there is a small bit of HTML used to format the first line of the body. Executing this transform will send the following email:
- TO: info@tartansolutions.com
- FROM: info@tartansolutions.com (remember that all messages come from this address)
- Subject: DEMO – Workflow Analyze Demo Running
4 - Notify Via Log
Description
Write a message to the Analyze workflow log.
Message Parameters
Type the desired message to write to the log. Then select one of three severity levels from the following:
- Information
- Warning
- Error
Please note that both Project Variables and Workflow Variables are available for use with this transform.
Examples
In this example, executing this transform will append an Information item to the log, stating Write a message to the workflow log. I believe you have my stapler, Demo.
5 - Notify via Microsoft Teams
Adding Microsoft Teams notifications from a workflow is a two part process. The two parts are:
- Create a Microsoft Teams external connection
- Add Microsoft Teams notification steps to your workflows
Add Microsoft Teams Notification Step to Workflow
Adding Microsoft Teams notification steps to the workflow is the same as adding other steps to a workflow. Upon adding the step, open the step configuration, complete the form, and save it. You can now test your Microsoft Teams notification.
Formatting the Microsoft Teams Message
Teams has many formatting options including adding images and mentioning users. Please reference the Teams Message Text Formatting documentation for details.
Create Microsoft Teams External Connection
This is a one-time setup to allow PlaidCloud to send Microsoft Teams notifications on your behalf. Microsoft Teams allows creation of a Webhook App (a generic way to send a notification over the internet). After creating the Webhook App in Microsoft Teams, add the supplied credentials to PlaidCloud to allow its use.
Microsoft Teams Webhook App Creation
These steps will need to be performed by a Microsoft Teams administrator. Follow the steps outlined here for Creating Incoming Webhook (Microsoft Teams Documentation).
PlaidCloud External Connection Setup
These steps will need to be performed by a PlaidCloud workspace administrator with permissions to create External Data Connections. Follow these steps to create the connection:
- Navigate to
Analyze > Tools > External Data Connections - Under the
+ New Connectionselection, pick Microsoft Teams Webhook - Complete the name, description, and paste in the webhook url generated during the webhook creation above. The name provided here will be shown as the selection in the workflow step so it should be descriptive if possible.
- Select the
+ Createbutton
Examples
No examples yet...
6 - Notify via Slack
Adding Slack notifications from a workflow is a two part process. The two parts are:
- Create a Slack Webhook external connection
- Add Slack notification steps to your workflows
Add Slack Notification Step to Workflow
Adding Slack notification steps to the workflow is the same as adding other steps to a workflow. Upon adding the step, open the step configuration, complete the form, and save it. You can now test your Slack notification.
Formatting the Slack Message
Slack has many formatting options including adding images and mentioning users. Please reference the Slack Text Formatting documentation for details.
Create Slack Webhook External Connection
This is a one-time setup to allow PlaidCloud to send Slack notifications on your behalf. Slack allows creation of a Webhook App (a generic way to send a notification over the internet). After creating the Webhook App in Slack, add the supplied credentials to PlaidCloud to allow its use.
Slack Webhook App Creation
These steps will need to be performed by a Slack administrator. Follow these steps to create a Slack Webhook App:
- From Slack, open the workspace control menu and select
Settings & administration > Manage Apps - Select
Custom Integrationsfrom the Apps category list - Select
Incoming Webhooksfrom the list of apps - Select the
Add to Slackbutton - On the next screen, select the Slack Channel you wish to post the messages and continue. This is the default channel that will be used but it can be overridden in each notification including sending DMs to specific individuals.
- Copy the webhook URL displayed. This will be used later so keep it in a safe place. It will look something like this:
https://hooks.slack.com/services/T04QZ1435/G02TGBFTOP8/K9GZrR2ThdJz1uSiL9YeZxoR - You can customize the appearance, name, and emoji before saving. These customizations are only the defaults and these can be overridden on each notification step within a PlaidCloud workflow.
PlaidCloud External Connection Setup
These steps will need to be performed by a PlaidCloud workspace administrator with permissions to create External Data Connections. Follow these steps to create the connection:
- Navigate to
Analyze > Tools > External Data Connections - Under the
+ New Connectionselection, pick Slack Webhook - Complete the name, description, and paste in the webhook url provided in step 6 above. The name provided here will be shown as the selection in the workflow step so it should be descriptive if possible.
- Select the
+ Createbutton
Examples
No examples yet...
7 - Notify Via SMS
Description
Send an SMS message. Messages are sent from info@tartansolutions.com email account. No outbound setup or data is required.
Carrier and Number
From the Mobile Provider dropdown list, select from hundreds of domestic and international providers. For the convenience of the majority of our customers, USA carriers are listed first, followed by all international options listed alphabetically.
Next, specify a valid phone number. Acceptable formats include the following:
- 5555555555
- 555.555-5555
- 555.555.5555
- 555-555-5555
Message
Specify Subject and Message as desired.
Please note that both Project Variables and Workflow Variables are available for use with this transform, in both the subject line as well as the message body.WARNING: Standard data rates may apply for recipients.
Examples
No examples yet...
8 - Notify Via Twitter
Description
Send a Twitter Direct Message (DM) from @plaidcloud.
Twitter Account
Specify the twitter account to receive the DM from @plaidcloud. This user must be following @plaidcloud to receive the message. It is allowable, although not required, to prefix the username with the at sign (@).
Message
Enter the desired message. Analyze will not permit a value longer than 140 characters.
Please note that both Project Variables and Workflow Variables are available for use with this transform.
Examples
In this example, a DM is sent from @PlaidCloud to @tartansolutions. System variables are used in the message. The final message reads, Analyze Demo is running on #PlaidCloud.
9 - Notify Via Web Hook
Description
Send a notification via Web Hook (URL).
Examples
No examples yet...