Webhooks Events and Payloads

In this topic:

• Trigger Events
  • Version Notes
  • Tableau Webhooks Behavior
• Payloads  
  • Example Payloads  

Trigger Events

The following events are supported:

Version Notes

• The AdminPromoted and AdminDemoted events are available when connecting to Tableau Cloud and Tableau Server 2021.1 and later.  These events currently only work when updating the user from or to a Site Administrator role. These events do not work to update a user from or to a Server Adminsitrator role.
• LabelCreated, LabelUpdated, and LabelDeleted events are available in REST API version 3.16 and when connecting to Tableau Cloud Currently not supported when connecting to Tableau Server.  

Tableau Webhooks Behavior

• In some cases, a Tableau event may cause more than one webhook request to be sent to the destination URL server. We recommend that you parse incoming webhook requests to filter duplicates. The JSON payloads of duplicate requests will be identical.

• When a server that has been sent a webhook request does not reply with a HTTP success code, the webhook will retry the request three times with diminishing frequency. (A HTTP success code is defined as any number in the 2xx range.)

  If it still fails after a total of four attempts (fist attempt and 3 retries), the webhook will no longer retry. This is counted as 1 delivery attempt failure. If the same HTTP Post is made again and has a total of 4 such delivery attempt failures, the webhook is automatically disabled and the Webhook owner will be notified using the email address of the account owner on Tableau Server. Any successful attempts will automatically reset the delivery count. A disabled webhook can be manually re-enabled using the Update a Webhook REST Endpoint. This auto-disable behavior is only seen when connecting to Tableau Server version 2021.1.

Payloads  

When one of the subscribed events fires, a JSON payload is sent to the URL that is configured. The payloads are the same format for all events but the content in the fields varies based on the event type.

Example Payloads  

Here are a few examples of the payloads and what information is included:

DatasourceCreated:

{
  "resource":"DATASOURCE",

  "event_type":"DatasourceCreated",

  "resource_name":"My Datasource",

  "site_luid":"8b2a95d8-52b9-40a4-8712-cd6da771bd1b",

  "resource_luid":"99",

  "created_at":"2018-11-15T17:14:45Z"
}

Datasource extract refresh:

{
  "resource":"EXTRACTS",

  "event_type":"DatasourceRefreshStarted",

  "resource_name":"My Datasource",

  "site_luid":"8b2a95d8-52b9-40a4-8712-cd6da771bd1b",

  "resource_luid":"99",

  "created_at":"2018-11-15T17:14:45Z"
}

Workbook created:

{
  "resource":"WORKBOOK",

  "event_type":"WorkbookCreated",

  "resource_name":"My Workbook",

  "site_luid":"8b2a95d8-52b9-40a4-8712-cd6da771bd1b",

  "resource_luid":"99",

  "created_at":"2018-11-15T17:14:45Z"

}

Workbook extract refresh started:

{
  "resource":"EXTRACTS",

  "event_type":"WorkbookRefreshStarted",

  "resource_name":"My Workbook",

  "site_luid":"8b2a95d8-52b9-40a4-8712-cd6da771bd1b",

  "resource_luid":"99",

  "created_at":"2018-11-15T17:14:45Z"

}

User Admin Promoted:

{
  "resource":"USER",

  "event_type":"AdminPromoted",

  "resource_name":"Test user",

  "site_luid":"8b2a95d8-52b9-40a4-8712-cd6da771bd1b",

  "resource_luid":"25",

  "created_at":"2018-11-15T17:14:45Z"

}

Label Created for datasource:

{
  "resource":"DATASOURCE",

  "event_type":"LabelUpdated",

  "resource_name":"My Datasource",

  "site_luid":"8b2a95d8-52b9-40a4-8712-cd6da771bd1b",

  "resource_luid":"12ab34cd-56ef-78ab-90cd-12ef34ab56cd",

  "created_at":"2022-05-15T17:14:45Z"
}