Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

Use this file to discover all available pages before exploring further.

Looking to ask data questions interactively in Slack? See Omni Slack Agent.

​
Requirements

To connect Slack to Omni, you’ll need Organization Admin permissions.

​
Common questions

When you connect your Slack workspace to Omni, Omni will request a few permissions. These permissions are required to successfully deliver content:
PermissionHow does Omni use it?Why is it requested?
Upload, edit, and delete files (files:write scope)Allows Omni to send report attachments to Slack channels and DMsSlack bundles upload, edit, and delete permissions into a single scope, meaning there isn’t a way to only request upload permissions
Join public channels in your workspace (channels:join)Allows Omni’s Slackbot to automatically join public channels specified in deliveriesWithout this permission, a Slack admin would need to manually invite the Omni Slackbot to every channel before setting up a delivery.

Note: This is only applicable to public channels. For private channels, someone must invite the Omni Slackbot first.
Omni’s Slack integration supports sending deliveries to channels (public and private) and individual users via a direct message (DM).Slackbot cannot receive Omni Slack deliveries.
Yes! See the Dynamic content deliveries with Mustache guide for more information.

​
Setup

1

Connect your Slack workspace

Before Omni can send deliveries to Slack, you’ll need to connect your Slack workspace. This is done on the Integrations page:
  1. In Omni, click Settings > Integrations.
  2. Click Connect to Slack and complete the Slack authorization flow.
You’ll be redirected back to Omni once the connection is established. For more details, refer to the Omni Slack Agent setup guide.
2

Configure delivery settings

  1. Navigate to a published dashboard.
  2. Click File > Deliveries & Alerts. The delivery options will display on the left side of the page.
  3. Fill in the following:
    • Delivery - Select Schedule or Alert.
    • Send -
    • Destination - Select .
    • Name - Enter a name for the delivery.
If creating an alert, use the Alert tab to define the conditions that must be met to trigger the delivery. For example, you have a chart that tracks the Total sales for your ecommerce company. Using an alert, you can trigger a delivery when the total of your sales has changed.
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
Schedules can be defined using the visual options or with cron:
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.
A cron expression is a string that describes the individual details of a schedule:
OrderUnitAllowed valuesAllowed special characters
1minute0-59* , - /
2hour0-23* , - /
3day of month1-31* , - / L W ?
4month1-12 or JAN-DEC* , - /
5day of week1-7 or SUN-SAT* , - / L W ?
6yearany* , - /
Using cron, you can create schedules like the following:
At 9:00 AM every day
0 9 ? * * *
At 6:30AM on the last day of the month
30 6 L * ? *
At 8:45 AM every day, Monday through Friday
45 8 ? * MON-FRI *
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.
If your organization has AI enabled, you can use the AI cron generator to create cron expressions from natural language. Click the sparkle icon next to the cron input field and describe your desired schedule, such as “every weekday at 9am” or “first Monday of each month at noon.”
Schedule send timezone may be different than query run timezone. For example, if your Database timezone is UTC with no other timezone conversion settings and you set your schedule to send at 12:00 PM PST, the query will execute at 8:00 PM UTC.Refer to your connection timezone settings for more information.
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.
For dashboard deliveries, the default filters and controls will automatically be applied upon creation. Subsequent default filter value updates will not change the filter values set for existing deliveries.
You can use filters to customize content for different recipients! For example, set a filter to A in a scheduled delivery to recipient A, and in another scheduled delivery to recipient B, set a filter to B.
5

Select a channel and add a message

The last step is to configure the Slack settings for the delivery:
  1. 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.
  2. 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.
Looking to see all of your Slack deliveries in one place?
  1. In Omni, click Settings > Deliveries.
  2. Click the Slack tab.
  3. 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.