Docs
Docs and feature guides
Start here: platform overview
Next generation Slack platform
Getting started
Automation
Overview
Samples & templates
Create or remove an app
App manifest
Functions
Slack functions
Connector functions
Custom functions
Testing custom functions
Workflows
Triggers
Starting workflows with triggers
Link triggers
Scheduled triggers
Event triggers
Webhook triggers
Trigger management
Working with data
Datastores
Built-in types
Custom types
Message metadata events
Working with APIs
Slack API methods
External authentication
Interactivity
Overview
Creating a form
Creating an interactive message
Creating an interactive modal
Deploying apps
Local development
Deploy to Slack
Permissions control for admins
Team collaboration
Environment variables
Security
Guided tutorials
Hello world
Give kudos
Create a custom function for Workflow Builder
Announcement bot
GitHub issue
Welcome bot
Define app
Open authorization
Virtual running buddies
Request time off
Extras
FAQ
Changelog
Give us feedback
Translated content
π―π΅
Slack CLI
Install & authorize
Uninstall
Commands
Command quick reference
CI/CD
CI/CD overview
CI/CD pipeline setup
Logging
Using Slack CLI on Enterprise Grid
Error troubleshooting
Deno & TypeScript
Deno overview
Install Deno
Develop with Deno
TypeScript overview
Slack apps
Getting started
Developing Slack apps
Introduction
Building with Bolt
Bolt SDKs
Developing with Bolt for JavaScript
Developing with Bolt for Python
Developing with Bolt for Java
Using app manifests
Designing Slack apps
Localizing Slack apps
Distributing Slack apps
App Directory
Overview
App Directory review guide
App Directory guidelines
Using the App Directory
App Directory checklist
Authentication
Overview
Installing with OAuth
Access tokens
Token rotation
Verifying requests
Security best practices
Sign in with Slack
Sign in with Slack setup
Sign in with Slack links
SIWS links using Auth0
Legacy app migration
Quickstart: what's new
Migration guide
Reference
Scopes
Messaging
Overview
Sending messages
Overview
Composing messages
Formatting messages
Adding interactivity
Modifying messages
Scheduling messages
Using Webhooks
Retrieving messages
Working with files
Working with metadata
Overview
Designing metadata schema
Metadata events
message_metadata_posted
message_metadata_updated
message_metadata_deleted
Event scope
Reference
Message payloads
Secondary attachments
Unfurling links in messages
Upgrading to blocks
Block Kit Builder
Surfaces
Overview
App Home
Modals
Messages
Reference
Defining views
Upgrading dialogs to modals
Deep linking into Slack
Block Kit
Overview
Building with Block Kit
Designing with Block Kit
Block Kit Builder
Reference
Overview
Blocks
Block elements & interactive components
Composition objects
Block actions payloads
Block suggestion payloads
Interactivity
Overview
Handling user interaction
Shortcuts
Slash Commands
Interaction payloads
Overview
Shortcuts payloads
Block actions payloads
Block suggestion payloads
View interaction payloads
APIs
Overview
Connection protocols
Overview
Using the Events API over HTTP
Socket Mode
Using the Web API
Overview
Pagination
Rate limits
Conversations API
Calls API
Presence & status
Bookmarks API
Slack Connect
Overview
Slack Connect APIs
Status API
Reference
Methods
Event types
Object types
Overview
Channel object
Conversation object
Event object
File object
Group object
IM object
MPIM object
User object
Usergroup object
Legacy
Overview
Legacy authentication
Legacy: V1 OAuth 2.0
Legacy: OAuth Scopes
Legacy: Sign in with Slack
Legacy messaging
Legacy: Messaging overview
Legacy: interactive messages
Legacy: Interactive field guide
Legacy: Message buttons
Legacy: Message menus
Legacy bots
Legacy dialogs
Legacy custom integrations
Legacy custom integrations migration
Legacy custom integrations bot users
Legacy custom integrations incoming webhooks
Legacy custom integrations outgoing webhooks
Legacy custom integations slash commands
Legacy custom integrations Web API
Legacy custom integrations tokens
Legacy: Steps from Apps
Legacy: RTM API
Workflow Builder
Getting started
Workflows for users
Pre-built workflows
Workflows for developers
Webhook triggers
Legacy steps from apps
Workflow Powerups
Reference
Configuration views
workflow_step
workflow_step_edit
workflow_step_execute
workflow_published
workflow_unpublished
workflow_deleted
workflow_step_deleted
Administration
Enterprise
Overview
Single-workspace apps
Overview
Preparing your apps
Testing an Enterprise app
Organization-wide apps
Overview
Preparing for organization-wide app deployment
OAuth & Installation for organization-wide apps
Using APIs with organization-wide apps
Migration
Reference
Apps for Admins
Overview
User management
Creating workspaces and managing users
Manging invite requests
Resetting user sessions
Workspace management
Managing channels
Managing app approvals
Managing workflow permissions and approvals
Legal Holds API
Overview
Methods
Reference
Scopes
Entity Types
Restrictions
Errors
Pagination
Audit Logs API
Monitoring audit events
Monitoring anomaly events
Calling the Audit Logs API
SCIM API
Provisioning with SCIM
Provisioning with SCIM 2.0
Reference
Translated content
π―π΅ ζ₯ζ¬θͺηγγΌγΈ
Gov Slack
Stay updated
Recent updates
Developer blog
@SlackAPI
Tools and resources
Our tools
Community tools
Get support
Partner with us
Slack Fund
FAQ
Developer beta
API Terms of Service
Community
Community Discussion
Groups and events
Slack Engineering
Community code of conduct
Reference
Docs and feature guides
Start here: platform overview
Next generation Slack platform
Getting started
Automation
Overview
Samples & templates
Create or remove an app
App manifest
Functions
Slack functions
Connector functions
Custom functions
Testing custom functions
Workflows
Triggers
Starting workflows with triggers
Link triggers
Scheduled triggers
Event triggers
Webhook triggers
Trigger management
Working with data
Datastores
Built-in types
Custom types
Message metadata events
Working with APIs
Slack API methods
External authentication
Interactivity
Overview
Creating a form
Creating an interactive message
Creating an interactive modal
Deploying apps
Local development
Deploy to Slack
Permissions control for admins
Team collaboration
Environment variables
Security
Guided tutorials
Hello world
Give kudos
Create a custom function for Workflow Builder
Announcement bot
GitHub issue
Welcome bot
Define app
Open authorization
Virtual running buddies
Request time off
Extras
FAQ
Changelog
Give us feedback
Translated content
π―π΅
Slack CLI
Install & authorize
Uninstall
Commands
Command quick reference
CI/CD
CI/CD overview
CI/CD pipeline setup
Logging
Using Slack CLI on Enterprise Grid
Error troubleshooting
Deno & TypeScript
Deno overview
Install Deno
Develop with Deno
TypeScript overview
Slack apps
Getting started
Developing Slack apps
Introduction
Building with Bolt
Bolt SDKs
Developing with Bolt for JavaScript
Developing with Bolt for Python
Developing with Bolt for Java
Using app manifests
Designing Slack apps
Localizing Slack apps
Distributing Slack apps
App Directory
Overview
App Directory review guide
App Directory guidelines
Using the App Directory
App Directory checklist
Authentication
Overview
Installing with OAuth
Access tokens
Token rotation
Verifying requests
Security best practices
Sign in with Slack
Sign in with Slack setup
Sign in with Slack links
SIWS links using Auth0
Legacy app migration
Quickstart: what's new
Migration guide
Reference
Scopes
Messaging
Overview
Sending messages
Overview
Composing messages
Formatting messages
Adding interactivity
Modifying messages
Scheduling messages
Using Webhooks
Retrieving messages
Working with files
Working with metadata
Overview
Designing metadata schema
Metadata events
message_metadata_posted
message_metadata_updated
message_metadata_deleted
Event scope
Reference
Message payloads
Secondary attachments
Unfurling links in messages
Upgrading to blocks
Block Kit Builder
Surfaces
Overview
App Home
Modals
Messages
Reference
Defining views
Upgrading dialogs to modals
Deep linking into Slack
Block Kit
Overview
Building with Block Kit
Designing with Block Kit
Block Kit Builder
Reference
Overview
Blocks
Block elements & interactive components
Composition objects
Block actions payloads
Block suggestion payloads
Interactivity
Overview
Handling user interaction
Shortcuts
Slash Commands
Interaction payloads
Overview
Shortcuts payloads
Block actions payloads
Block suggestion payloads
View interaction payloads
APIs
Overview
Connection protocols
Overview
Using the Events API over HTTP
Socket Mode
Using the Web API
Overview
Pagination
Rate limits
Conversations API
Calls API
Presence & status
Bookmarks API
Slack Connect
Overview
Slack Connect APIs
Status API
Reference
Methods
Event types
Object types
Overview
Channel object
Conversation object
Event object
File object
Group object
IM object
MPIM object
User object
Usergroup object
Legacy
Overview
Legacy authentication
Legacy: V1 OAuth 2.0
Legacy: OAuth Scopes
Legacy: Sign in with Slack
Legacy messaging
Legacy: Messaging overview
Legacy: interactive messages
Legacy: Interactive field guide
Legacy: Message buttons
Legacy: Message menus
Legacy bots
Legacy dialogs
Legacy custom integrations
Legacy custom integrations migration
Legacy custom integrations bot users
Legacy custom integrations incoming webhooks
Legacy custom integrations outgoing webhooks
Legacy custom integations slash commands
Legacy custom integrations Web API
Legacy custom integrations tokens
Legacy: Steps from Apps
Legacy: RTM API
Workflow Builder
Getting started
Workflows for users
Pre-built workflows
Workflows for developers
Webhook triggers
Legacy steps from apps
Workflow Powerups
Reference
Configuration views
workflow_step
workflow_step_edit
workflow_step_execute
workflow_published
workflow_unpublished
workflow_deleted
workflow_step_deleted
Administration
Enterprise
Overview
Single-workspace apps
Overview
Preparing your apps
Testing an Enterprise app
Organization-wide apps
Overview
Preparing for organization-wide app deployment
OAuth & Installation for organization-wide apps
Using APIs with organization-wide apps
Migration
Reference
Apps for Admins
Overview
User management
Creating workspaces and managing users
Manging invite requests
Resetting user sessions
Workspace management
Managing channels
Managing app approvals
Managing workflow permissions and approvals
Legal Holds API
Overview
Methods
Reference
Scopes
Entity Types
Restrictions
Errors
Pagination
Audit Logs API
Monitoring audit events
Monitoring anomaly events
Calling the Audit Logs API
SCIM API
Provisioning with SCIM
Provisioning with SCIM 2.0
Reference
Translated content
π―π΅ ζ₯ζ¬θͺηγγΌγΈ
Gov Slack
Stay updated
Recent updates
Developer blog
@SlackAPI
Tools and resources
Our tools
Community tools
Get support
Partner with us
Slack Fund
FAQ
Developer beta
API Terms of Service
Community
Community Discussion
Groups and events
Slack Engineering
Community code of conduct
Tutorials
Tutorials
Give Kudos
Hello World
Announcement Bot
Welcome Bot
GitHub Issue
Create a custom function for Workflow Builder
Define App
Request Time Off
Your apps
Sign in to Slack to manage apps
Start here: platform overview
Next generation Slack platform
Getting started
Automation
Overview
Samples & templates
Create or remove an app
App manifest
Functions
Slack functions
Connector functions
Custom functions
Testing custom functions
Workflows
Triggers
Starting workflows with triggers
Link triggers
Scheduled triggers
Event triggers
Webhook triggers
Trigger management
Working with data
Datastores
Built-in types
Custom types
Message metadata events
Working with APIs
Slack API methods
External authentication
Interactivity
Overview
Creating a form
Creating an interactive message
Creating an interactive modal
Deploying apps
Local development
Deploy to Slack
Permissions control for admins
Team collaboration
Environment variables
Security
Guided tutorials
Hello world
Give kudos
Create a custom function for Workflow Builder
Announcement bot
GitHub issue
Welcome bot
Define app
Open authorization
Virtual running buddies
Request time off
Extras
FAQ
Changelog
Give us feedback
Translated content
π―π΅
Slack CLI
Install & authorize
Uninstall
Commands
Command quick reference
CI/CD
CI/CD overview
CI/CD pipeline setup
Logging
Using Slack CLI on Enterprise Grid
Error troubleshooting
Deno & TypeScript
Deno overview
Install Deno
Develop with Deno
TypeScript overview
Slack apps
Getting started
Developing Slack apps
Introduction
Building with Bolt
Bolt SDKs
Developing with Bolt for JavaScript
Developing with Bolt for Python
Developing with Bolt for Java
Using app manifests
Designing Slack apps
Localizing Slack apps
Distributing Slack apps
App Directory
Overview
App Directory review guide
App Directory guidelines
Using the App Directory
App Directory checklist
Authentication
Overview
Installing with OAuth
Access tokens
Token rotation
Verifying requests
Security best practices
Sign in with Slack
Sign in with Slack setup
Sign in with Slack links
SIWS links using Auth0
Legacy app migration
Quickstart: what's new
Migration guide
Reference
Scopes
Messaging
Overview
Sending messages
Overview
Composing messages
Formatting messages
Adding interactivity
Modifying messages
Scheduling messages
Using Webhooks
Retrieving messages
Working with files
Working with metadata
Overview
Designing metadata schema
Metadata events
message_metadata_posted
message_metadata_updated
message_metadata_deleted
Event scope
Reference
Message payloads
Secondary attachments
Unfurling links in messages
Upgrading to blocks
Block Kit Builder
Surfaces
Overview
App Home
Modals
Messages
Reference
Defining views
Upgrading dialogs to modals
Deep linking into Slack
Block Kit
Overview
Building with Block Kit
Designing with Block Kit
Block Kit Builder
Reference
Overview
Blocks
Block elements & interactive components
Composition objects
Block actions payloads
Block suggestion payloads
Interactivity
Overview
Handling user interaction
Shortcuts
Slash Commands
Interaction payloads
Overview
Shortcuts payloads
Block actions payloads
Block suggestion payloads
View interaction payloads
APIs
Overview
Connection protocols
Overview
Using the Events API over HTTP
Socket Mode
Using the Web API
Overview
Pagination
Rate limits
Conversations API
Calls API
Presence & status
Bookmarks API
Slack Connect
Overview
Slack Connect APIs
Status API
Reference
Methods
Event types
Object types
Overview
Channel object
Conversation object
Event object
File object
Group object
IM object
MPIM object
User object
Usergroup object
Legacy
Overview
Legacy authentication
Legacy: V1 OAuth 2.0
Legacy: OAuth Scopes
Legacy: Sign in with Slack
Legacy messaging
Legacy: Messaging overview
Legacy: interactive messages
Legacy: Interactive field guide
Legacy: Message buttons
Legacy: Message menus
Legacy bots
Legacy dialogs
Legacy custom integrations
Legacy custom integrations migration
Legacy custom integrations bot users
Legacy custom integrations incoming webhooks
Legacy custom integrations outgoing webhooks
Legacy custom integations slash commands
Legacy custom integrations Web API
Legacy custom integrations tokens
Legacy: Steps from Apps
Legacy: RTM API
Workflow Builder
Getting started
Workflows for users
Pre-built workflows
Workflows for developers
Webhook triggers
Legacy steps from apps
Workflow Powerups
Reference
Configuration views
workflow_step
workflow_step_edit
workflow_step_execute
workflow_published
workflow_unpublished
workflow_deleted
workflow_step_deleted
Administration
Enterprise
Overview
Single-workspace apps
Overview
Preparing your apps
Testing an Enterprise app
Organization-wide apps
Overview
Preparing for organization-wide app deployment
OAuth & Installation for organization-wide apps
Using APIs with organization-wide apps
Migration
Reference
Apps for Admins
Overview
User management
Creating workspaces and managing users
Manging invite requests
Resetting user sessions
Workspace management
Managing channels
Managing app approvals
Managing workflow permissions and approvals
Legal Holds API
Overview
Methods
Reference
Scopes
Entity Types
Restrictions
Errors
Pagination
Audit Logs API
Monitoring audit events
Monitoring anomaly events
Calling the Audit Logs API
SCIM API
Provisioning with SCIM
Provisioning with SCIM 2.0
Reference
Translated content
π―π΅ ζ₯ζ¬θͺηγγΌγΈ
Gov Slack
Stay updated
Recent updates
Developer blog
@SlackAPI
Tools and resources
Our tools
Community tools
Get support
Partner with us
Slack Fund
FAQ
Developer beta
API Terms of Service
Community
Community Discussion
Groups and events
Slack Engineering
Community code of conduct
View all scopes
team.preferences:read
View other scopes
Allows your slack app to read the preferences for workspaces your slack app has been installed to
Facts
Supported token types
User
Legacy bot
Bot
Compatible API methods
team.preferences.list
On this page
Facts