For datasets that use the ElasticStore to track results, use Data Update Alerts to raise alerts when the data is not updated upon an expected interval. For example, if a query didn’t execute as scheduled, this will trigger an alert that can be sent via email/webhook/Slack.
Sections
- Creating a Data Update Alert
- Alert Actions: Email
- Alert Actions: Webhook
- Alert Actions: Slack
- Alert Actions: Teams
Creating a Data Update Alert
This outlines the initial steps to create the alert.
-
From any dashboard, click the Alerts icon on the left sidebar
-
In the Alerts Management screen, Click Add Data Update Alerts +.
-
This opens the Alerts Options window.
-
Give your Alert a name. This is how it will be displayed in Alerts Management.
-
In the Dataset dropdown, select the dataset to create an alert for.
-
In the Run Every section, schedule the alert to run at a chosen interval.
- Skip Alert if data is same as last alert: Check this box to skip this alert If the data is the same as the last alert. Useful to avoid repetitive alerts.
- Select an Alert Action to configure an alert to be sent via email/webhook/Slack/Teams.
Alert Actions
Email Alerts allows you to send the alert via email along with a CSV attachment of results to a list of recipients.
To set up an Email Alert:
- Under Alert Actions, select the Email tab.
- Enter the Email Subject that will be displayed.
- In the Email From section, enter the email address that the email will be sent from (support@knowi.com by default). This address will appear as the sender of the email when received in your inbox.
- Enter the email address of the recipient(s). Comma separated for multiple recipients.
- Enter the Email Body. (optional) Write custom HTML to customize the email template.
- Attach Full Dataset as CSV (optional): Check this box to attach the full underlying dataset as a CSV to the email.
- Attach Results after Cloud9QL as CSV (optional): Check this box to attach the results after the trigger condition as a CSV to the email.
- Click Test Run (optional) to send a test email alert to the chosen recipient(s).
- Once the configuration is complete, click Save.
Webhook
Webhook Alerts allow you to send an alert directly to your application (or third-party applications). When the condition is triggered, we'll send a POST request with a JSON payload of the data, which you can use to drive actions within your application.
The data in the POST will be a JSON formatted dataset of the full raw dataset for which the alert is generated.
To set up a Webhook Alert:
- Under Alert Actions, select the Webhook tab.
- Click + New Webhook. This opens up the Add Webhook window.
- Under URL to Invoke, enter the endpoint in your application that can accept a post request with JSON (Array of Objects). For example: https://somehost.com/someEndpoint.
- Enter an Authentication URL. In cases where you need to call an authentication endpoint first to obtain a token, which is then passed into the actual POST request, use the Authentication URL. along with any Authentication headers. This will invoke a separate POST call to obtain an auth token first, which can be subsequently passed as a token into the Headers section. For example:
-
Authorization: Bearer {access token}
-
- Under Headers, enter any optional authentication-related headers. One header per line. For example:
- Under Auth Headers, enter any optional authentication-related headers. One header per line. For example:
- Use Full Dataset into the POST (optional): If checked, the whole underlying dataset is used to post data. If unchecked, then the results after Cloud9QL which triggered the data will be used.
- Click Save.
- Click Test Run (optional) to send a test webhook alert to the chosen application. Here’s an example of the results in JSON form:
- Once the configuration is complete, click Save.
Slack
Slack integration allows you to trigger actions in your Slack channel(s) for a given condition triggered by an alert. When the condition is triggered, we'll send a message to a predefined channel(s) including the attachment of full data or conditional data depending on the options selected.
To set up a Slack Alert:
- Under Alert Actions, select the Slack tab.
- If this is your first time connecting Knowi to Slack, click the New Team icon. Follow the prompts to give Knowi access to your Slack account.
- Click + Add Slack. This opens up the Add Slack sidebar.
- Give your Alert a name.
- Under Alert Message, enter a user-defined message that will show up when the Alert is received in Slack. If left blank, it will send a default message.
- In the Alert Team dropdown, choose the Slack workspace to send the Alert to.
- In the Alert Channels dropdown, choose the Slack channel to publish the Alert notifications to.
- Attach Full Dataset as CSV (optional): Check this box to attach the full underlying dataset as a CSV to the Slack Alert.
- Send a slack message for each row of alert data (optional): Check this box to send a slack message for each row of alert data.
- Click Save.
- Click Test Run (optional) to send a test Slack alert to the chosen channel(s). Here’s how the Alert will show up in your Slack channel:
- Once the configuration is complete, click Save.
Teams
MS Teams integration allows you to trigger actions in your Teams channel(s) for a given condition triggered by an alert. When the condition is triggered, we'll send a message to a predefined channel(s) including the attachment of full data or conditional data depending on the options selected.
To set up a Teams Alert:
- Under Alert Actions, select the Teams tab.
- Click + Add Teams. This opens up the Add Teams window.
- Give your Alert a name.
- Under Alert Message, enter a user-defined message that will show up when the Alert is received in Teams. If left blank, it will send a default message.
- In the Alert Team dropdown, choose the Teams workspace to send the Alert to.
- In the Alert Channels dropdown, choose the Teams channel to publish the Alert notifications to.
- In Cloud9QL filter before POST text box, enter any additional manipulation to the data that will be sent to Teams.
- Attach Full Dataset as CSV (optional): Check this box to attach the full underlying dataset as a CSV to the Teams Alert.
- Attach Results after Cloud9QL as CSV (optional): Check this box to attach the results after the Alert condition as a CSV to the email.
- Click Save.
- Click Test Run (optional) to send a test Teams alert to the chosen channel(s).
- Once the configuration is complete, click Save.