View as Markdown
Sigma icon

Sigma ACTION

Create Workbook

Creates a new blank workbook. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Sigma account once, then configure and run Create Workbook from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "sigma-create-workbook",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sigma: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    folderId: "Folder ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Workbook inputs
Property Type Description
name Name string
The name for the new workbook.
Required
folderId Folder ID string
Folder where the workbook should be saved within the user's Sigma environment.
Required Dynamic
description Description string
A description for the workbook.
Optional
ownerId Member ID string
ID of the user (member) who will own the workbook.
Optional Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
sigma-create-workbook
Version
0.0.2
App
Sigma
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes