The Bookmarks API is an opportunity for channels and conversations to create streamlined access to important team documents for onboarding, JIRA boards for ongoing projects, and commonly-referenced messages within Slack.
This API provides you the ability to add
, remove
, edit
or list
curated resources directly in public channels, private channels, direct messages, multi-person direct messages, and our newest channel type, Shared Channels.
Bookmarks can contain external resources such as websites, spreadsheets, dashboards, wikis, news articles, as well as internal resources such as messages, files, or other channels within Slack. These resources are readily available in the header of your Slack client near pinned messages.
The bookmarks.add method currently accepts the following types:
link
In addition to updating your Slack app's scope permissions, the following scopes are required:
The Bookmarks API not only adds decorative emoji icons β¨ to the bookmarks bar of your channels and messages, it also provides you with more customization and organization options by allowing anyone to enable easy access to various types of files, documents, and links.
For example, some of your day-to-day tasks may include creating nearly identical channels that function similarly but have different sets of teams or objectives (think #proj-, #help-, and #incident- channels to support the same project). Now you can programmatically create new channels with as many pre-determined bookmarked internal files or externally-linked documents as needed, allowing your teams to work more efficiently.
Bookmarking a link
requires you to specify the following: channel_id
, title
, type
, and url
.
Example of a POST request to bookmarks.add
for a link
:
https://slack.com/api/bookmarks.add?channel_id=C123TGZ4XYX&title=bookmark-test&type=link&link=http%3A%2F%2Fslack.com
Channels and conversation are limited to 100 bookmarks.