> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Tableau

> How to set up the Tableau connector, plus the actions and events that are available.

![Tableau](https://stackone-logos.com/api/tableau/filled/svg)

Previewv1.2.0[See changelog](https://docs.stackone.com/connectors/tableau/changelog.md)

[122 actions](#actions) · [23 events](#events) · 1 auth method

Analytics
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Personal Access Token · Connector Profile](https://docs.stackone.com/connectors/tableau/guides/connector-profile/personal-access-token.md)
>
> Use your Tableau Personal Access Token (PAT) for secure API authentication. PATs are long-lived tokens that can be revok...

Optionally, configure receiving Events for Tableau into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/tableau/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Personal Access Token · Link Account](https://docs.stackone.com/connectors/tableau/guides/link-account/personal-access-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

tableau:\*:\*

tableau:content:read

tableau:content:write

tableau:datasource\_tags:update

tableau:datasources:delete

tableau:datasources:download

tableau:datasources:update

tableau:domains:read

tableau:domains:update

tableau:embedding\_site\_settings:read

tableau:embedding\_site\_settings:update

tableau:groups:create

tableau:groups:read

tableau:groups:update

tableau:groups:write

tableau:jobs:read

tableau:jobs:update

tableau:permissions:delete

tableau:permissions:read

tableau:permissions:update

tableau:projects:create

tableau:projects:delete

tableau:projects:read

tableau:projects:update

tableau:recommendation\_dismissals:delete

tableau:schedules:read

tableau:server:read

tableau:server\_admin\_tokens:delete

tableau:sessions:delete

tableau:sites:delete

tableau:sites:read

tableau:sites:switch

tableau:sites:write

tableau:tasks:read

tableau:tasks:run

tableau:users:create

tableau:users:read

tableau:users:update

tableau:users:write

tableau:views:download

tableau:views:read

tableau:views:update

tableau:workbook\_downgrade\_info:read

tableau:workbooks:delete

tableau:workbooks:update

No scopes found

122 actions

ActionDescriptionRequired scopes

Query Data Sources`tableau_query_datasources`

Get a list of all data sources on the site

`tableau:content:read`

Query Data Source`tableau_query_datasource`

Get details of a specific data source

`tableau:content:read`

Update Data Source`tableau_update_datasource`

Update data source properties

`tableau:datasources:update`

Delete Data Source`tableau_delete_datasource`

Delete a data source from the site

`tableau:datasources:delete`

Query Data Source Connections`tableau_query_datasource_connections`

Get connection details for a data source

`tableau:content:read`

Update Data Source Connection`tableau_update_datasource_connection`

Update connection details for a data source

`tableau:datasources:update`

Get Data Source Revisions`tableau_get_datasource_revisions`

Get revision history for a data source

`tableau:content:read`

Remove Data Source Revision`tableau_remove_datasource_revision`

Delete a specific revision of a data source

`tableau:datasources:delete`

Add Tags To Data Source`tableau_add_tags_to_datasource`

Add tags to a data source

`tableau:datasource_tags:update`

Download Data Source`tableau_download_datasource`

Download a data source file

`tableau:datasources:download`

List Unified Groups`tableau_unified_list_groups`

List unified groups in Tableau.

`tableau:groups:read`

Get Unified Group`tableau_unified_get_group`

Get a unified Tableau group by ID.

`tableau:groups:read`

List Unified Resource Types`tableau_unified_list_resource_types`

List unified resource types in Tableau.

`tableau:sites:read`

List Unified Resource Users`tableau_unified_list_resource_users`

List unified resource users in Tableau.

`tableau:permissions:read`

List Unified Roles`tableau_unified_list_roles`

List unified roles in Tableau.

`tableau:sites:read`

Get Unified Role`tableau_unified_get_role`

Get a unified Tableau role by ID.

`tableau:sites:read`

List Unified Users`tableau_unified_list_users`

List unified users in Tableau.

`tableau:users:read`

Get Unified User`tableau_unified_get_user`

Get a unified Tableau user by ID.

`tableau:users:read`

List Schedules`tableau_list_schedules`

Get all schedules on the site

`tableau:schedules:read`

List Extract Refresh Tasks For Site`tableau_list_extract_refresh_tasks_for_site`

Get all extract refresh tasks on the site

`tableau:tasks:read`

Run Extract Refresh Task`tableau_run_extract_refresh_task`

Run an extract refresh task immediately

`tableau:tasks:run`

Query Jobs`tableau_query_jobs`

Get all jobs on the site

`tableau:jobs:read`

Get Job`tableau_get_job`

Get details of a specific job

`tableau:jobs:read`

Cancel Job`tableau_cancel_job`

Cancel a running or pending job

`tableau:jobs:update`

List Project Permissions`tableau_list_project_permissions`

Get permissions for a specific project

`tableau:permissions:read`

Add Project Permissions`tableau_add_project_permissions`

Add permissions to a project for a user or group

`tableau:permissions:update`

Delete Project Permission For User`tableau_delete_project_permission_for_user`

Remove a specific permission from a project for a user

`tableau:permissions:delete`

Delete Project Permission For Group`tableau_delete_project_permission_for_group`

Remove a specific permission from a project for a group

`tableau:permissions:delete`

List Workbook Permissions`tableau_list_workbook_permissions`

Get permissions for a specific workbook

`tableau:permissions:read`

Add Workbook Permissions`tableau_add_workbook_permissions`

Add permissions to a workbook for a user or group

`tableau:permissions:update`

Delete Workbook Permission For User`tableau_delete_workbook_permission_for_user`

Remove a specific permission from a workbook for a user

`tableau:permissions:delete`

Delete Workbook Permission For Group`tableau_delete_workbook_permission_for_group`

Remove a specific permission from a workbook for a group

`tableau:permissions:delete`

List Data Source Permissions`tableau_list_datasource_permissions`

Get permissions for a specific datasource

`tableau:permissions:read`

Add Datasource Permissions`tableau_add_datasource_permissions`

Add permissions to a datasource for a user or group

`tableau:permissions:update`

Delete Datasource Permission For User`tableau_delete_datasource_permission_for_user`

Remove a specific permission from a datasource for a user

`tableau:permissions:delete`

Delete Datasource Permission For Group`tableau_delete_datasource_permission_for_group`

Remove a specific permission from a datasource for a group

`tableau:permissions:delete`

List Default Workbook Permissions`tableau_list_default_workbook_permissions`

Get default workbook permissions for a project

`tableau:permissions:read`

List Default Datasource Permissions`tableau_list_default_datasource_permissions`

Get default datasource permissions for a project

`tableau:permissions:read`

Add Default Workbook Permissions`tableau_add_default_workbook_permissions`

Add default workbook permissions to a project

`tableau:permissions:update`

Add Default Datasource Permissions`tableau_add_default_datasource_permissions`

Add default datasource permissions to a project

`tableau:permissions:update`

Delete Default Workbook Permissions For User`tableau_delete_default_workbook_permissions_for_user`

Remove default workbook permissions from a project for a user

`tableau:permissions:delete`

Delete Default Workbook Permissions For Group`tableau_delete_default_workbook_permissions_for_group`

Remove default workbook permissions from a project for a group

`tableau:permissions:delete`

Delete Default Datasource Permissions For User`tableau_delete_default_datasource_permissions_for_user`

Remove default datasource permissions from a project for a user

`tableau:permissions:delete`

Delete Default Datasource Permissions For Group`tableau_delete_default_datasource_permissions_for_group`

Remove default datasource permissions from a project for a group

`tableau:permissions:delete`

Query Projects`tableau_query_projects`

Get a list of all projects on the site

`tableau:content:read`

Create Project`tableau_create_project`

Create a new project on the site

`tableau:projects:create`

Update Project`tableau_update_project`

Update an existing project

`tableau:projects:update`

Delete Project`tableau_delete_project`

Delete a project from the site

`tableau:projects:delete`

Get Server Info`tableau_get_server_info`

Get Tableau Server product and version information

`tableau:server:read`

Query Current Site`tableau_query_current_site`

Get details of the site you are signed into

`tableau:sites:read`

Get Current Server Session`tableau_get_current_server_session`

Get information about the current session

`tableau:content:read`

Delete Server Session`tableau_delete_server_session`

Delete a specified server session (Tableau Server only)

`tableau:sessions:delete`

Sign Out`tableau_sign_out`

Sign out and invalidate the current authentication token

`tableau:*:*`

Switch Site`tableau_switch_site`

Switch to another site without re-authenticating (Tableau Server only)

`tableau:sites:switch`

Revoke Admin Personal Access Tokens`tableau_revoke_admin_personal_access_tokens`

Revoke all PATs created by server administrators (Tableau Server only)

`tableau:server_admin_tokens:delete`

List Server Active Directory Domains`tableau_list_server_active_directory_domains`

List all Active Directory domains configured on the server (Tableau Server only)

`tableau:domains:read`

Update Server Active Directory Domain`tableau_update_server_active_directory_domain`

Update an Active Directory domain configuration (Tableau Server only)

`tableau:domains:update`

Query Site By Name`tableau_query_site_by_name`

Get site details by site name

`tableau:sites:read`

Query Site By Content URL`tableau_query_site_by_content_url`

Get site details by content URL

`tableau:sites:read`

Get Recently Viewed`tableau_get_recently_viewed`

Get recently viewed content for the current user

`tableau:content:read`

Get Embedding Settings`tableau_get_embedding_settings`

Get embedding settings for the site

`tableau:embedding_site_settings:read`

Update Embedding Settings`tableau_update_embedding_settings`

Update embedding settings for the site

`tableau:embedding_site_settings:update`

Update Site`tableau_update_site`

Update site settings

`tableau:sites:write`

Create Site`tableau_create_site`

Create a new site (Server Admin only)

`tableau:sites:write`

Delete Site`tableau_delete_site`

Delete a site by ID (Server Admin only)

`tableau:sites:delete`

Get Site By ID`tableau_get_site_by_id`

Get site details using the site ID

`tableau:sites:read`

Delete Site By Content URL`tableau_delete_site_by_content_url`

Delete a site using its content URL (Server Admin only)

`tableau:sites:delete`

Delete Site By Name`tableau_delete_site_by_name`

Delete a site using its site name (Server Admin only)

`tableau:sites:delete`

Query Views For Site`tableau_query_views_for_site`

Get all views across all workbooks in the site

`tableau:content:read`

List Sites`tableau_list_sites`

List all sites on Tableau Server (not available for Tableau Cloud)

`tableau:sites:read`

Get User Personal Space`tableau_get_user_personal_space`

Get the personal space for the current user (API 3.13+)

`tableau:projects:read`

List Authentication Configurations`tableau_list_authentication_configurations`

List authentication configurations for a site (API 3.24+, Tableau Cloud only)

`tableau:sites:read`

Delete Site Asynchronously`tableau_delete_site_async`

Delete a site asynchronously by ID (Server Admin only)

`tableau:sites:delete`

Delete Site Asynchronously By Name`tableau_delete_site_by_name_async`

Delete a site asynchronously by name (Server Admin only)

`tableau:sites:delete`

Delete Site Asynchronously By Content URL`tableau_delete_site_by_content_url_async`

Delete a site asynchronously by content URL (Server Admin only)

`tableau:sites:delete`

Query User On Site`tableau_query_user_on_site`

Get details of a specific user on the site

`tableau:users:read`

Get Users On Site`tableau_get_users_on_site`

List all users on the site with filtering and pagination

`tableau:users:read`

Add User To Site`tableau_add_user_to_site`

Add a new user to the site

`tableau:users:create`

Update User`tableau_update_user`

Update user details on the site

`tableau:users:update`

Remove User From Site`tableau_remove_user_from_site`

Remove a user from the site

`tableau:users:write`

Get Groups For User`tableau_get_groups_for_user`

Get all groups that a user belongs to

`tableau:users:read`

Query Groups`tableau_query_groups`

Get a list of all groups on the site

`tableau:groups:read`

Create Group`tableau_create_group`

Create a new group on the site

`tableau:groups:create`

Update Group`tableau_update_group`

Update a group on the site

`tableau:groups:update`

Delete Group`tableau_delete_group`

Delete a group from the site

`tableau:groups:write`

Get Users In Group`tableau_get_users_in_group`

Get all users that belong to a group

`tableau:groups:read`

Add User To Group`tableau_add_user_to_group`

Add a user to a group

`tableau:groups:update`

Remove User From Group`tableau_remove_user_from_group`

Remove a user from a group

`tableau:groups:update`

List Personal Access Tokens`tableau_list_personal_access_tokens`

List all personal access tokens for a user (Tableau Cloud only)

`tableau:users:read`

Revoke Personal Access Token`tableau_revoke_personal_access_token`

Revoke a personal access token (Tableau Cloud only)

`tableau:users:write`

Query Workbooks For Site`tableau_query_workbooks_for_site`

Get a list of all workbooks on the site

`tableau:content:read`

Query Workbooks For User`tableau_query_workbooks_for_user`

Get all workbooks owned by a specific user

`tableau:content:read`

Query Workbook`tableau_query_workbook`

Get details of a specific workbook

`tableau:content:read`

Update Workbook`tableau_update_workbook`

Update workbook properties including name, owner, project, and acceleration settings

`tableau:workbooks:update`

Delete Workbook`tableau_delete_workbook`

Delete a workbook from the site

`tableau:workbooks:delete`

Refresh Workbook`tableau_refresh_workbook`

Refresh all extracts in a workbook

`tableau:tasks:run`

Query Workbook Connections`tableau_query_workbook_connections`

Get connection details for a workbook

`tableau:content:read`

Update Workbook Connection`tableau_update_workbook_connection`

Update connection details for a workbook

`tableau:workbooks:update`

Get Workbook Revisions`tableau_get_workbook_revisions`

Get revision history for a workbook

`tableau:content:read`

Add Tags To Workbook`tableau_add_tags_to_workbook`

Add tags to a workbook

`tableau:content:write`

Delete Tag From Workbook`tableau_delete_tag_from_workbook`

Remove a tag from a workbook

`tableau:content:write`

Query Views For Workbook`tableau_query_views_for_workbook`

Get all views in a specific workbook

`tableau:content:read`

Get View`tableau_get_view`

Get details of a specific view

`tableau:views:read`

Query View Data`tableau_query_view_data`

Get underlying data from a view in CSV format

`tableau:views:download`

Add Tags To View`tableau_add_tags_to_view`

Add tags to a view

`tableau:content:write`

Delete Tag From View`tableau_delete_tag_from_view`

Remove a tag from a view

`tableau:content:write`

List Custom Views`tableau_list_custom_views`

Get a list of custom views on the site

`tableau:content:read`

Get Custom View`tableau_get_custom_view`

Get details of a specified custom view

`tableau:content:read`

Update Custom View`tableau_update_custom_view`

Update a custom view's name or owner

`tableau:views:update`

Delete Custom View`tableau_delete_custom_view`

Delete a custom view

`tableau:content:write`

Download Workbook`tableau_download_workbook`

Download the workbook file in .twbx format

`tableau:content:read`

Download Workbook As PDF`tableau_download_workbook_pdf`

Export the workbook as a PDF file

`tableau:content:read`

Download Workbook As PowerPoint`tableau_download_workbook_powerpoint`

Export the workbook as a PowerPoint file

`tableau:content:read`

Download Workbook Revision`tableau_download_workbook_revision`

Download a specific revision of a workbook

`tableau:content:read`

Get Workbook Preview Image`tableau_get_workbook_preview_image`

Get the preview image for a workbook

`tableau:content:read`

Query View Image`tableau_query_view_image`

Get the view rendered as an image

`tableau:content:read`

Query View PDF`tableau_query_view_pdf`

Export a view as a PDF file

`tableau:content:read`

Download View Crosstab As Excel`tableau_download_view_crosstab_excel`

Export view data as an Excel crosstab file

`tableau:content:read`

Get View By Path`tableau_get_view_by_path`

Get view details using the view's URL name

`tableau:content:read`

Hide View Recommendation`tableau_hide_view_recommendation`

Hide a recommended view for the current user

`tableau:content:write`

Unhide View Recommendation`tableau_unhide_view_recommendation`

Unhide a previously hidden view recommendation

`tableau:recommendation_dismissals:delete`

Get Workbook Downgrade Info`tableau_get_workbook_downgrade_info`

Get version compatibility information for downgrading a workbook

`tableau:workbook_downgrade_info:read`

## Events

Tags

Select all
|
Clear

Data Sources

Extracts

Labels

Sites

Users

Views

Webhooks

Workbooks

No tags found

23 events

EventDescriptionTags

Webhook Test`tableau_webhook_test`

Responds with 200 OK to any request without an event\_type, without emitting an event.

Webhooks

Data Source Created`tableau_webhook_datasource_created`

Fired when a data source is published to the site.

Data SourcesWebhooks

Data Source Updated`tableau_webhook_datasource_updated`

Fired when a published data source is updated.

Data SourcesWebhooks

Data Source Deleted`tableau_webhook_datasource_deleted`

Fired when a published data source is deleted.

Data SourcesWebhooks

Data Source Refresh Started`tableau_webhook_datasource_refresh_started`

Fired when an extract refresh of a published data source starts.

ExtractsWebhooks

Data Source Refresh Succeeded`tableau_webhook_datasource_refresh_succeeded`

Fired when an extract refresh of a published data source succeeds.

ExtractsWebhooks

Data Source Refresh Failed`tableau_webhook_datasource_refresh_failed`

Fired when an extract refresh of a published data source fails.

ExtractsWebhooks

Label Created`tableau_webhook_label_created`

Fired when a data label is added to a data source or workbook.

LabelsWebhooks

Label Updated`tableau_webhook_label_updated`

Fired when a data label on a data source or workbook is updated.

LabelsWebhooks

Label Deleted`tableau_webhook_label_deleted`

Fired when a data label is removed from a data source or workbook.

LabelsWebhooks

Site Created`tableau_webhook_site_created`

Fired when a site is created.

SitesWebhooks

Site Updated`tableau_webhook_site_updated`

Fired when a site's settings are updated.

SitesWebhooks

Site Deleted`tableau_webhook_site_deleted`

Fired when a site is deleted.

SitesWebhooks

Admin Promoted`tableau_webhook_admin_promoted`

Fired when a user is promoted to a Site Administrator role.

UsersWebhooks

Admin Demoted`tableau_webhook_admin_demoted`

Fired when a user is demoted from a Site Administrator role.

UsersWebhooks

User Deleted`tableau_webhook_user_deleted`

Fired when a user is removed from the site.

UsersWebhooks

View Deleted`tableau_webhook_view_deleted`

Fired when a view is deleted.

ViewsWebhooks

Workbook Created`tableau_webhook_workbook_created`

Fired when a workbook is published to the site.

WorkbooksWebhooks

Workbook Updated`tableau_webhook_workbook_updated`

Fired when a published workbook is updated.

WorkbooksWebhooks

Workbook Deleted`tableau_webhook_workbook_deleted`

Fired when a published workbook is deleted.

WorkbooksWebhooks

Workbook Refresh Started`tableau_webhook_workbook_refresh_started`

Fired when an extract refresh of a workbook starts.

ExtractsWebhooks

Workbook Refresh Succeeded`tableau_webhook_workbook_refresh_succeeded`

Fired when an extract refresh of a workbook succeeds.

ExtractsWebhooks

Workbook Refresh Failed`tableau_webhook_workbook_refresh_failed`

Fired when an extract refresh of a workbook fails.

ExtractsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.