This is reference content about building functions and workflows. Learn more if you're not yet familiar with this new Slack platform paradigm.

add_bookmark

Add a bookmark to a channel

Facts

Schema ID

Schema.slack.functions.AddBookmark

Schema reference

slack#/functions/add_bookmark

Required scopes

bookmarks:write

Input parameters

Required parameters

channel_id

Schema.slack.types.channel_id

·Required

The ID for the channel you are bookmarking the item in

C123ABC456
D123ABC456

name

Schema.types.string

·Required

Bookmark name

Luke's road trip plans

link

Schema.types.string

·Required

Bookmark URL

https://example.slack.com/lists/T012AB3CD/F01ABC2DE3F

Output parameters

Required parameters

channel_id

Schema.slack.types.channel_id

·Required

The ID for the channel

C123ABC456
D123ABC456

bookmark_name

Schema.slack.types.string

·Required

Name of the bookmark

Great Wisconsin Cheese Festival schedule of events

bookmark_link

Schema.slack.types.string

·Required

URL of the bookmark

https://cheesefest.org/

Usage guide

Adds a bookmark to a channel.

Example workflow step

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