Skip to main content

canvas_create

Facts

Description
Schema
Schema reference
Required scopes
No additional scopes required

Input Parameters

Output Parameters

Usage info

This function creates a canvas. If canvas_create_type is not passed, it is set as blank.

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 create your canvases, refer to expanded_rich_text.

Example workflow step​

const createCanvasStep = ExampleWorkflow.addStep(
  Schema.slack.functions.CanvasCreate,
  {
    title: "My new canvas",
    owner_id: "PERSON12345",
    canvas_create_type: "blank",
    content: { inputs.content }
  },
);