Creating a Slack delivery
1. Connect your Slack workspace
Connecting Slack to Omni requires Organization Admin permissions.
- In Omni, click Settings > Deliveries.
- Click the Slack tab.
- Click Connect to Slack.
2. Configure delivery settings
- Navigate to a published dashboard.
- Click File > Deliveries & Alerts. The delivery options will display on the left side of the page.
-
Fill in the following:
- Delivery - Select Schedule or Alert.
- Send -
- Destination - Select .
- Name - Enter a name for the delivery.
3. Configure the delivery schedule
In this step, you’ll define the cadence for the delivery:- For schedules, this determines when Omni will deliver the specified content to the destination
- For alerts, this tells Omni when to check if the current query results meet the conditions required to send the delivery
Visual schedule builder
Easy point-and-click schedule builder
Visual schedule builder
Easy point-and-click schedule builder
Use the UI options (Daily, Weekly, etc.) to select a time period.By default, schedules are set to send in the local timezone of the delivery creator’s computer. Use the Times are in drop down to change the timezone.
Custom cron schedule (Advanced)
Code-based granular timing control
Custom cron schedule (Advanced)
Code-based granular timing control
A cron expression is a string that describes the individual details of a schedule:
Using cron, you can create schedules like the following:Omni uses Amazon Web Services’ (AWS) syntax for cron expressions. Refer to the AWS documentation for more information. By default, the most frequent you can configure a schedule is hourly.
| Order | Unit | Allowed values | Allowed special characters |
|---|---|---|---|
| 1 | minute | 0-59 | * , - / |
| 2 | hour | 0-23 | * , - / |
| 3 | day of month | 1-31 | * , - / L W ? |
| 4 | month | 1-12 or JAN-DEC | * , - / |
| 5 | day of week | 1-7 or SUN-SAT | * , - / L W ? |
| 6 | year | any | * , - / |
At 9:00 AM every day
At 6:30AM on the last day of the month
At 8:45 AM every day, Monday through Friday
4. Select format and filter options
In the Dashboard or Chart tab, you can:- Select the format of the content, such as PNG, PDF, XLSX, or CSV
- Lightly customize the contents and layout, such as expanding tables to include up to 1,000 rows, hiding filter values, or arranging tiles in a single column.
- Set filter or control values for the delivery. Some formats will have additional customization options. PDF formats, for example, will allow you to specify the orientation and page size for the PDF.
5. Select a channel and add a message
The last step is to configure the Slack settings for the delivery:-
Select a channel or direct message. Public and private channels are supported.
To deliver content to a private channel, you’ll also need to add the Omni app (
@omni) to the private channel.If you don’t see the private channel in the Channel dropdown, click the Add channel link. Use the modal to enter the ID of the channel. - Add a message. Messages can include Mustache references for dynamic, personalized content and be formatted using Slack markup.
6. Test the delivery
If you want to test the delivery before saving, click the Test Now button in the bottom left corner of the page. This will send the dashboard/chart to the destination using the current settings. For example, using Test Now would send the delivery to all Recipients.The Test Now button will be unavailable for alerts if the Condition type is
Results have changed or Results have stayed the same. A workaround is to use the Send Now option to manually trigger the delivery, which is available once the delivery has been saved.Save the alert and then click the icon to display the Send Now option. This will initiate a check on the alert condition - if the condition isn’t met, the delivery will show as successful but not send anything.7. Save the delivery
When finished, click Save to create the delivery.Viewing all Slack deliveries
Viewing Slack deliveries requires Organization Admin permissions.
- In Omni, click Settings > Deliveries.
- Click the Slack tab.
- Click the link under Connected to Omni. You’ll be redirected to a filtered view of the All Deliveries tab, which will display all the deliveries currently sent to Slack.