Skip to main content

share_canvas

Facts

Description
Schema
Schema reference
Required scopes
No additional scopes required

Input Parameters

Output Parameters

Usage info

This function allows you to share a canvas to users and channels.

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 shareCanvasStep = ExampleWorkflow.addStep(
  Schema.slack.functions.ShareCanvas,
  {
    canvas_id: "CAN123456",
    channel_ids: ["C111AAA111","C222BBB222"],
    user_ids: ["U333DDD333","U444EEE444"],
    access_level: "edit",
    message: [
      {
        "type": "rich_text",
        "elements": [
          {
            "type": "rich_text_section",
            "elements": [{
              "type": "text",
              "text": "Sharing the create canvas",
            }],
          },
        ],
      },
    ],
  },
);