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

canvas_create

Create a canvas

Facts

Schema ID

Schema.slack.functions.CanvasCreate

Schema reference

slack#/functions/canvas_create

Required scopes

canvases:readcanvases:write

Input parameters

Required parameters

title

Schema.types.string

·Required

Canvas name

owner_id

Schema.slack.types.user_id

·Required

Canvas owner

Optional parameters

canvas_create_type

Schema.types.string

·Optional

Type of creation. Options are blank or template. Default is blank. If type is blank or undefined, no canvas_template_id is needed. If type is template, provide a canvas_template_id.

canvas_template_id

Schema.slack.types.canvas_template_id

·Optional

Select a canvas template. Only needed if canvas_create_type is set to template.

content

Schema.slack.types.expanded_rich_text

·Optional

Add content. Content should only be provided if canvas_create_type is set to blank.

placeholder_values

Schema.types.object

·Optional

A dictionary of key-value pairs representing canvas variables provided only when canvas_create_type is set to template.

Output parameters

Required parameters

canvas_id

Schema.slack.types.canvas_id

·Required

Canvas link

Usage guide

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 update 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 }
  },
);