Skip to main content

add_bookmark

Facts​

DescriptionAdd a bookmark to a channel
SchemaSchema.slack.functions.AddBookmark
Schema referenceslack#/functions/add_bookmark
Required scopes
bookmarks:write

Input Parameters​

Required Input Parameters

channel_idSchema.slack.types.channel_idRequired

The ID for the channel you are bookmarking the item in

Examples
C123ABC456
D123ABC456
linkSchema.types.stringRequired

Bookmark URL

Examples
https://example.slack.com/lists/T012AB3CD/F01ABC2DE3F
nameSchema.types.stringRequired

Bookmark name

Examples
Luke's road trip plans

Output Parameters​

Required Output Parameters

bookmark_linkSchema.slack.types.stringRequired

URL of the bookmark

Examples
https://cheesefest.org/
bookmark_nameSchema.slack.types.stringRequired

Name of the bookmark

Examples
Great Wisconsin Cheese Festival schedule of events
channel_idSchema.slack.types.channel_idRequired

The ID for the channel

Examples
C123ABC456
D123ABC456

Usage info​

Example workflow step​

const addBookmarkStep = ExampleWorkflow.addStep(
  Schema.slack.functions.AddBookmark,
  {
    channel_id: "C0123ABC456",
    name: "Great Wisconsin Cheese Festival",
    link: "https://cheesefest.org/",
  },
);