> ## 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.

# Webhook deliveries

> Customize your Omni deliveries with webhooks.

export const contentCopy_0 = "Select the content to be delivered."

export const destination_0 = "Webhook"

If you want to customize your Omni deliveries, webhooks may be a good fit. While you can specify some things - like the email sender for email deliveries or the channel message for Slack deliveries - webhooks give you the ability to create context-specific workflows.

For example, you could use a platform like [Zapier](https://www.zapier.com) to catch Omni webhooks and perform different actions based on data values, such as those for CSV-formatted deliveries.

## Requirements

To successfully use Omni webhook deliveries, your webhook must return an HTTP `200` status response upon delivery. A different status could cause delivery retries or failures.

## Creating a webhook delivery

<Steps>
  <Step title="Create a webhook URL" titleSize="h3" id="webhook-url">
    Prior to using webhooks as a delivery destination, you'll need to create a webhook URL for Omni to send requests to. For example, using Zapier's webhook trigger in a Zap will create a webhook URL for you to use.

    <Note>
      If access to your webhook server is restricted, you'll need to whitelist Omni's IP addresses to ensure deliveries are successful.

      Omni's IP addresses can be found on any database connection's page, accessed by navigating to **Settings > Connections** and clicking a connection. **All IP addresses on this page must be included in the allowlist.**
    </Note>
  </Step>

  <Step title="Configure the delivery settings" titleSize="h3" id="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** - {contentCopy_0}
       * **Destination** - Select **{destination_0}**.
       * **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.
  </Step>

  <Step title="Configure the delivery schedule" titleSize="h3" id="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:

    <AccordionGroup>
      <Accordion title="Visual schedule builder" icon="calendar" description="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.
      </Accordion>

      <Accordion title="Custom cron schedule (Advanced)" icon="asterisk" description="Code-based granular timing control">
        A cron expression is a string that describes the individual details of a schedule:

        | 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             | \* , - /                   |

        Using cron, you can create schedules like the following:

        ```markdown title="At 9:00 AM every day" theme={null}
        0 9 ? * * *
        ```

        ```markdown title="At 6:30AM on the last day of the month" theme={null}
        30 6 L * ? *
        ```

        ```markdown title="At 8:45 AM every day, Monday through Friday" theme={null}
        45 8 ? * MON-FRI *
        ```

        Omni uses Amazon Web Services' (AWS) syntax for cron expressions. Refer to the [AWS documentation](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html) for more information. By default, the most frequent you can configure a schedule is hourly.

        <Tip>
          If your organization has [AI enabled](/ai/settings/features), 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."
        </Tip>
      </Accordion>
    </AccordionGroup>

    <Tip>
      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](/connect-data/timezones) for more information.
    </Tip>
  </Step>

  <Step title="Select format and filter options" titleSize="h3" id="format-filter-options">
    <Tip>
      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`.
    </Tip>

    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.
    * **Select the page(s) to include in the dashboard delivery**. This is applicable only to [advanced layouts](/visualize-present/dashboards/advanced-layout) with multiple pages.

      **Note**: PNGs can only include one page. You'll need to create multiple deliveries to output a PNG for each page.
    * **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.
  </Step>

  <Step title="Configure webhook settings" id="webhook-settings" titleSize="h3">
    The last step is to configure the webhook settings. Click the **Webhook** tab and fill in the following:

    * **URL** - Enter the webhook URL you created in [step 1 of this guide](/share/deliveries/webhooks#webhook-url).
    * **File Name (Without extension)** - Optionally specify a file name for the delivery, leaving out a file extension like `.png`. [Mustache references](/share/deliveries/dynamic-content) are supported.
  </Step>

  <Step title="Test the delivery" id="test-delivery" titleSize="h3">
    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**.

    <Note>
      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 icon="ellipsis-vertical" type="solid" /> 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.
    </Note>
  </Step>

  <Step title="Save the delivery" id="save-delivery" titleSize="h3">
    When finished, click **Save** to create the delivery.
  </Step>
</Steps>

## Request formats

The type of delivery Omni sends determines the format the request body will take:

### Link-only

Omni will send a `POST` request with a JSON object in the body that contains:

```json title="Webhook delivery request body" theme={null}
{  "url": "<dashboard_url>"}
```

### All file formats

Omni will send a `POST` request with the file content directly in the body using streaming delivery:

* **Headers**:
  * `Content-Type` - Appropriate MIME type (`text/csv`, `application/json`, `application/pdf`, `image/png`, etc.)
  * `Content-Length` - Size of the file in bytes (when available)
  * `X-Filename` - Original filename for reference
* **Body**: Raw file content streamed directly

<Note>
  For dashboard deliveries with multiple queries, CSV content will be delivered as a ZIP file with `Content-Type: application/zip`.
</Note>