Action: Create Workbook Refresh

Tableau Operation

The Create Workbook Refresh action updates a workbook's data connections and refreshes its visualizations.

Example User Story

I want to refresh a specific workbook so that the data is up-to-date.

Fields

Field Name	Field Type	Required
workbookId	String	Yes

Related Connections

Tableau

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "workbook-refresh",
  "state": "inDev",
  "meta": {
    "short": "Refresh Workbook",
    "description": "Refreshes a specific workbook in Tableau."
  },
  "input": [
    {
      "name": "workbookId",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The ID of the workbook to refresh."
      }
    }
  ],
  "output": [
    {
      "name": "status",
      "type": "String",
      "selector": ["response", "status"],
      "meta": {
        "description": "The status of the refresh operation."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/api/3.9/sites/{{siteId}}/workbooks/{{workbookId}}/refresh",
        "headers": {
          "Content-Type": "application/json",
          "Accept": "application/json"
        },
        "bodyTemplate": {
          "value": "{}"
        }
      }
    }
  ]
}