Export to webhook (Beta)

πŸ“˜

This feature is currently in beta. Beta features are subject to quick, iterative changes. As a result, this document may not reflect the most current version. In order to access this feature, please place a request with your customer success manager or reach out to the support chat to have it enabled for your organization.

This feature does not currently support export to authenticated endpoints.

Sigma webhook exports allow you to send data to your own webhook endpoint or to other applications such as Marketo, Segment, or Airtable, using a webhook. You can export your workbook data on an as-needed basis or create one or more schedules for recurring exports. Each schedule can support multiple endpoints and send conditions.

User requirements

The ability to export to webhooks requires the following:

  • You must be assigned an account type with the Export to webhook permission enabled.

  • You must be the workbook owner or be granted Can explore or Can edit workbook permission.

Supported formats

The following file types are available for all webhook exports:

  • CSV
  • JSON

Export limit

The webhook export limit is the same global limit for all exports, 1 million rows. There is no separate limit for webhook exports.

Send an ad hoc webhook export

  1. From the workbook menu (caret icon), select Send now.
    The Send Now modal opens.

  2. Set the DestinationΒ to Webhook Export.
    The modal changes to show webhook-related fields.
    Send Now modal with webhook selected, showing endpoint, document version or bookmark, attachment, and format as options.

  3. For the Endpoint, enter one or more target webhook endpoints.

    • Separate multiple endpoints with commas.
    • Endpoint URLs must start with https://.
  4. If the workbook has versions, select which one you want to send.

  5. From the Attachment menu, select a data element to export.
    Sigma organizes the elements by page.
    send-now-attachment-menu.png

  6. From the Format as menu, select an export format, either CSV or JSON.

  7. Click Send.

    πŸ“˜

    The exports contain published workbook content only. Draft changes aren't reflected.

Schedule a recurring export

  1. From the workbook menu (β–Ό), select Schedule exports.
    Sigma opens the Schedule Exports modal.
  2. a. If this is the workbook's first schedule, click Add Schedule.
    b. If one or more schedules already exist, click + New Schedule. The New schedule modal opens.
  3. Change Destination toΒ Webhook.
  4. Follow steps 3-6 in the steps to send an ad hoc webhook export.
  5. Set the delivery schedule.
    • For Repeat by select a schedule option: Day/Week, Month or Custom.
    • From the Timezone, select a time zone.
    • Setting a schedule's frequency depends on the Repeat by selection.
      • Day/Week: pick the schedule's day or days of the week (On days), how often on a day (Occurrence) and time of day (At).
      • Month: Select the Day of month (1-31) and time (At).
      • Custom: Enter a raw cron string value. For more information, see Set up a custom delivery schedule.
  6. (Optional) Select one or more workbook controls to apply to the exported content. For more information, see Apply control values to scheduled reports.
    • In the search box below Controls, search for and select the control by control ID.
    • Select the control value(s) to apply to the scheduled export.
    • Repeat this step to add additional controls.
  7. Click Create Schedule.