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
LabelCreated webhook-source-event-label-created
LabelUpdated webhook-source-event-label-updated
LabelDeleted webhook-source-event-label-LabelDeleted

Version Notes

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 format for all events but the content in the fields varies 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 LUID.
created_at The time stamp of when the datasource was created.

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 LUID.
created_at The time stamp of when the workbook was created.

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 LUID.
created_at The time stamp of when the user was created.

Label events

The payloads for the label events (label created, label updated, label deleted) are the same, but the resource field can differ. An example using a datasource asset could look like:

{
  "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"
}
Field  Description
resource  The type of asset the label event applies to.
event_type  Type of event that occurred. Can be LabelCreated, LabelUpdated, or LabelDeleted.
resource_name  Name of the asset in question.
site_luid  LUID for the site that contains the asset.
resource_luid  The asset LUID.
created_at The time stamp of when the label was created.