Skip to main content

share_canvas_in_thread

Facts​

DescriptionShare a canvas in thread
SchemaSchema.slack.functions.ShareCanvasInThread
Schema referenceslack#/functions/share_canvas_in_thread
Required scopes
chat:writeim:writechat:write.publicgroups:writecanvases:readcanvases:write

Input Parameters​

Required Input Parameters

access_levelSchema.types.stringRequired

Select an access level. Options are view or edit.

canvas_idSchema.slack.types.canvas_idRequired

The ID of the canvas to share

message_contextSchema.slack.types.message_contextRequired

The message to reply to

Optional Input Parameters

messageSchema.slack.types.rich_textOptional

Add a message

reply_broadcastSchema.types.booleanOptional

Send to the conversation as well

Output Parameters​

Optional Output Parameters

canvas_idSchema.slack.types.canvas_idOptional

Canvas link

message_contextSchema.slack.types.message_contextOptional

Reference to the sent message

Usage info​

This function allows you to share a canvas in a thread.

The app using this function will need the following App Home features set in the app manifest file:

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

Example workflow step:​

const shareCanvasStep = ExampleWorkflow.addStep(
  Schema.slack.functions.ShareCanvasInThread,
  {
    canvas_id: "CAN123456",
    access_level: "edit",
	message_context: inputs.messageContext,
    message: { inputs.message }
  },
);