Webhooks Events and Payloads


In this topic:

Trigger Events

Note: Starting in Tableau 2020.3, the `event` attribute of your webhook is the preferred place to specify the triggering event. `webhook-source` can also be used or omitted, as long as there is no conflict between the event described in the two elements.   

The following events are supported:

event Name webhook-source Name
DatasourceRefreshStarted webhook-source-event-datasource-refresh-started
DatasourceRefreshSucceeded webhook-source-event-datasource-refresh-succeeded
DatasourceRefreshFailed webhook-source-event-datasource-refresh-failed
DatasourceUpdated webhook-source-event-datasource-updated
DatasourceCreated webhook-source-event-datasource-created
DatasourceDeleted webhook-source-event-datasource-deleted
WorkbookUpdated webhook-source-event-workbook-updated
WorkbookCreated webhook-source-event-workbook-created
WorkbookDeleted webhook-source-event-workbook-deleted
WorkbookRefreshStarted webhook-source-event-workbook-refresh-started
WorkbookRefreshSucceeded webhook-source-event-workbook-refresh-succeeded
WorkbookRefreshFailed webhook-source-event-workbook-refresh-failed
AdminPromoted webhook-event-user-promoted-admin
AdminDemoted webhook-event-user-demoted-admin
Note: The AdminPromoted and AdminDemoted events are available when connecting to 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.  

Tableau Webhooks Behavior

Payloads  

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

Datasource Events  

The payloads for the datasource events (refresh started, refresh succeeded, refresh failed, created, deleted, updated) are the same:  

{
  "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"
}
Field Description
resource  Will always be “DATASOURCE” for datasource events.
event_type  Type of event that occurred. Can be DatasourceRefreshStarted, DatasourceRefreshSucceeded, DatasourceRefreshFailed, DatasourceCreated, DatasourceDeleted, or DatasourceUpdated.
resource_name  Name of the datasource in question.
site_luid  LUID for the site that contains the datasource.
resource_luid  The datasource ID.

Workbook Events  

The payloads for the workbook events (created, deleted, updated) are the same:  

{
  "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"

}

Field  Description 
resource  Will always be “WORKBOOK” for workbook events.
event_type  Type of event that occurred. Can be WorkbookRefreshStarted, WorkbookRefreshSucceeded, and WorkbookRefreshFailed.
resource_name  Name of the workbook in question.
site_luid  LUID for the site that contains the workbook.
resource_luid  The workbook ID.

User Events 

The payloads for the user events (AdminPromoted and AdminDemoted) are the same:  

{
  "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"

}

Field  Description
resource  Will always be “USER” for user events.
event_type  Type of event that occurred. Can be AdminPromoted or AdminDemoted.
resource_name  Name of the user.
site_luid  LUID for the site that the user has permissions to.
resource_luid  The user ID.