This is reference content about building functions and workflows. Learn more if you're not yet familiar with this new Slack platform paradigm.

canvas_copy

Copy a canvas. This API method can only be used on Enterprise Grid workspaces.

Facts

Schema ID

Schema.slack.functions.CanvasCopy

Schema reference

slack#/functions/canvas_copy

Required scopes

canvases:readcanvases:write

Input parameters

Required parameters

canvas_id

Schema.slack.types.canvas_id

·Required

Select a canvas

title

Schema.types.string

·Required

Canvas name

owner_id

Schema.slack.types.user_id

·Required

Owner

Optional parameters

placeholder_values

Schema.types.object

·Optional

A dictionary of key-value pairs representing canvas variables.

Output parameters

Required parameters

canvas_id

Schema.slack.types.canvas_id

·Required

Canvas link

Usage guide

This function copies a canvas. The app using this function will need the following App Home features set in the app manifest file:

features: {
  appHome: {
    messagesTabEnabled: true,
    messagesTabReadOnlyEnabled: false,
  },
},

For information about the expanded_rich_text type that you can use to update your canvases, refer to expanded_rich_text.

Example workflow step:

const copyCanvasStep = ExampleWorkflow.addStep(
  Schema.slack.functions.CanvasCopy,
  {
    canvas_id: "CAN87654",
    title: "My new canvas",
    owner_id: "ABC123456"
  },
);