Contents
Getting Started
CloudAware supports two types of Slack integration:
1) Slack CloudAware Application
2) Slack Webhook URL
Possible use cases:
- 30-Day spending exceeds certain amount
- IDS detects an attack against an instance
- Server health deteriorates
- Incident management
Slack CloudAware Application
Use case: You would like to be notified about any high and critical vulnerability detected.
Creating Application In CloudAware
1. Log in to your CloudAware account → Admin
2. Select Slack CloudAware Application in Other integrations. Click +Add
3. Name your integration → Save
4. Click Add to Slack
5. Grant CloudAware App necessary permissions and select a Slack channel the notifications will be posted to. Click Allow
6. You will be notified about CloudAware App set up for your Slack Workspace via email and Slack channel
7. The green light in 'Status' means that Slack CloudAware Application has been created successfully. If there is a red light, please contact support@cloudaware.com
Configuring Slack Notifications
1. Select Slack Notification in Other integrations. Click +Add
2. Select 'Integrated Slack Application'. Fill in the integration details* selecting the app you set up before. Click Save
*Name, Message are mandatory fields.
In our use case we are creating the Upgrade Request notification. Use sObject.CA10__risk__c where CA10__risk__c is API Name of the object.
Use Fields List to determine fields you'd like to exclude from being displayed in your Slack message (Name in this example).
Object Name, Message, Color, Url Base are expression fields. The data type of the value returned depends on the elements used in the expression. Here are sample outputs:
Expression | Output |
---|---|
test | test |
sObject.Name | ‘the name of this field in your org’ |
‘sObject.Name ’ | sObject.Name |
‘Hey, ‘+sObject.Name ’ | Hey, ‘the name of this field in your org’ |
Hey, +sObject.Name | Hey, +sObject.Name |
‘good’ | good |
sObject.colour_c | ‘the name of this field in your org’ |
sObject.CA10_severity_c== “High”? ‘danger’ : ‘good’ | danger/good |
3. Copy and save the URL as it is required for further configuration in CloudAware (see Configuring CloudAware Workflow To Invoke Slack Action).
Incoming Slack Webhook URL
Use case: You would like to get the notification in Slack channel when package upgrade is requested by your customer (custom object: CloudAware Upgradable package).
Webhook Configuration In Slack
1. Enter your Apps Directory in Slack → Incoming Webhooks → toggle 'Activate Incoming Webhooks' to On → Add New Webhook to Workspace (see more here)
2. Grant your App necessary permissions and select a Slack channel the notifications will be posted to. Click Allow
3. Copy the Webhook URL and save it for later use
Adding Slack Webhook To Cloudaware
1. Log in to your CloudAware account → Admin
2. Select Slack Notification in Other integrations. Click +Add
3. Select 'Slack Webhook URL'. Fill in the integration details* → Save
*Name, Slack Webhook URL, Message are mandatory fields.
In our use case we are creating the Upgrade Request notification (replace Test by the customer name). To understand which instance the package needs to be upgraded on, insert sObject.CA10_Instance_c where CA10_Instance_c is API Name of the object (CloudAware Upgradable Package in this example).
Use Fields List to determine fields you'd like to exclude from being displayed in your Slack message (Name in this example).
Object Name, Message, Color, Url Base are expression fields. The data type of the value returned depends on the elements used in the expression. Here are sample outputs:
Expression | Output |
---|---|
test | test |
sObject.Name | ‘the name of this field in your org’ |
‘sObject.Name ’ | sObject.Name |
‘Hey, ‘+sObject.Name ’ | Hey, ‘the name of this field in your org’ |
Hey, +sObject.Name | Hey, +sObject.Name |
‘good’ | good |
sObject.colour_c | ‘the name of this field in your org’ |
sObject.CA10_severity_c == “High”? ‘danger’ : ‘good’ | danger/good |
You can apply standard Slack formatting in the field Message. In our use case we apply bold message format by adding * before the text of the message.
4. The green light in 'Status' means that Slack Notification Webhook has been configured successfully. If there is a red light, please contact support@cloudaware.com
5. Copy and save the URL as it is required for further configuration in Cloudaware (see Configuring Cloudaware Workflow To Invoke Slack Action)
Configuring CloudAware Workflow To Invoke Slack Action
1. In your CloudAware account click Setup in the main menu
2. In the Quick Find box start typing workflows to select Workflows & Approvals → Workflow Rules → New Rule
3. Select the object for the rule to be applied to (in our use case CloudAware Upgradable Package) and click Next
4. Add Rule Name (1), set Evaluation Criteria(2) and Rule Criteria(3)*. Add Filter Logic if necessary. Click Save & Next
*In our use case we are creating a workflow rule will send out alerts when the field 'Upgrade' (checkbox) is true on CloudAware Upgradable Package object.
5. Add Workflow Action → New Outbound Message. Paste the copied Endpoint URL. Click Save
6. Review the workflow. Click Done to activate it
7. Once this workflow rule is triggered, the following Slack notification may be sent: