share_canvas

Facts

DescriptionShare a canvas

SchemaSchema.slack.functions.ShareCanvas

Schema referenceslack#/functions/share_canvas

Required scopes

chat:writeim:writechat:write.publicgroups:writecanvases:readcanvases:write

Input Parameters

Required Input Parameters

access_levelSchema.types.stringRequired

Select access level. Options are view or edit.

canvas_idSchema.slack.types.canvas_idRequired

Select a canvas

Optional Input Parameters

channel_idsSchema.types.arrayOptional

Select channels. Maximum is 10.

messageSchema.slack.types.rich_textOptional

Add a message

user_idsSchema.types.arrayOptional

Select people. Maximum is 10.

Output Parameters

Optional Output Parameters

canvas_idSchema.slack.types.canvas_idOptional

Canvas link

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