canvas_update_content

Facts

DescriptionUpdates a canvas

SchemaSchema.slack.functions.CanvasUpdateContent

Schema referenceslack#/functions/canvas_update_content

Required scopes

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

Input Parameters

Required Input Parameters

actionSchema.types.stringRequired

How do you want to update? Options are append, prepend, or replace. Default is prepend.

contentSchema.slack.types.expanded_rich_textRequired

Content to add to the canvas

Optional Input Parameters

canvas_idSchema.slack.types.canvas_idOptional

Select a canvas in cases when canvas_update_type is set to standalone.

canvas_update_typeSchema.types.stringOptional

Type of update. Options are standalone or channel_canvas. Default is standalone.

channel_idSchema.slack.types.channel_idOptional

Select a channel in cases when canvas_update_type is set to channel_canvas.

section_idSchema.types.stringOptional

Choose which section to update

Output Parameters

Required Output Parameters

canvas_idSchema.slack.types.canvas_idRequired

Canvas link

Usage info

This function updates the content of a canvas. Either canvas_id or channel_id must be provided, but not both. Which one is needed is based on the canvas_update_type. If the canvas_update_type is set to standalone, then a canvas_id should be provided. If canvas_update_type is set to channel_canvas, then a channel_id should be provided. The default value of canvas_update_type is standalone.

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 updateCanvasStep = ExampleWorkflow.addStep(
  Schema.slack.functions.CanvasUpdateContent,
  {
    action: "append",
    content: { inputs.content },
    canvas_update_type: "standalone",
    canvas_id: "CAN1234ABC"
  },
);

Facts​

Input Parameters​