Docs
Docs and feature guides
Automating Slack with workflows
Automation
Overview
Introduction
Quickstart
Samples & templates
Give us feedback
Building Run On Slack apps
Create or remove an app
App manifest
Environment variables
Slack functions
Custom functions
Testing custom functions
Workflows
Security
Bolt for next generation Slack apps
Triggering workflows
Triggers overview
Link triggers
Scheduled triggers
Event triggers
Webhook triggers
Trigger management
Working with APIs
Slack API methods
External authentication
Working with data
Datastores
Built-in types
Custom types
Message metadata events
Interactivity
Using forms
Block Kit interactivity
Modal View interactivity
Deploying apps
Local development
Deploy to Slack
Permissions control for admins
Team collaboration
Guided tutorials
Extras
FAQ
Changelog
Translated content
🇯🇵
Slack CLI
Install & authorize
Commands
CLI quick reference
Logging
Error troubleshooting
Customizing Slack with apps
Start learning
Overview
Intro to the Slack platform
Planning your app
Overview
Plotting interactions
Choosing the right APIs
Communicating with users
Interaction guidelines
Designing a great experience
Overview
Home tab guidelines
Modal guidelines
Shortcut guidelines
Choosing voice and tone
Localizing apps
Onboarding users
General guidelines
Building an app
Overview
Building with Bolt
Developing with Bolt for Python
Developing with Bolt for Java
Workflow Builder
Block Kit Builder
SDKs and tools
App blueprints
Distributing an app
Overview
Building for the App Directory
App Directory Review Guide
App Directory Guidelines
App directory checklist
Distributing apps publicly
Authentication
Overview
Installation & Permissions
Basic app setup
Installing with OAuth
Quickstart: what's new
Migration guide
Token rotation
Security
Verifying requests
Best practices
Access tokens
Token types
Configuration tokens
Sign in with Slack
Get started with Sign in with Slack
Sign in with Slack links
SIWS links using Auth0
Reference
Scopes
Messaging
Overview
Managing messages
Overview
Retrieving messages
Sending messages
Modifying messages
Scheduling messages
Using Webhooks
Composing messages
Overview
Formatting text
Rich message layouts
Interactive messages
Block Kit Builder
Working with files
Overview
Uploading files
Adding remote files
Reference
Message payloads
Block kit reference
Secondary attachments
Unfurling links in messages
Upgrading to blocks
Metadata
Overview
Using metadata
Metadata events
message_metadata_posted
message_metadata_updated
message_metadata_deleted
Event scope
Metadata schemas
Surfaces
Overview
Home tabs
Overview
Using your Home tab
Events in App Home
Modals
Overview
Using modals
Messages
Reference
Defining views
Block Kit
Overview
Building with Block Kit
Interactivity in Block Kit
Block Kit builder
App templates
Reference
Overview
Layout blocks
Block elements
Interactive components
Composition objects
Defining views
block_actions payloads
View interaction payloads
Upgrading to modals
Accessibility
Interactivity
Overview
Handling user interaction
Entry points
Shortcuts
Slash Commands
Interaction payloads
Overview
Shortcuts payloads
block_actions payloads
View interaction payloads
APIs
Overview
Connection protocols
Overview
Using the Events API over HTTP
Intro to Socket Mode
Socket Mode implementation
Usage guides
Using the Web API
Overview
Pagination
Rate limits
Calls API
Presence & status
Bookmarks API
Slack Connect
Overview
Slack Connect APIs
Status API
Reference
Methods
Event types
Object types
Workflows
Overview
Workflows for users
Pre-built workflows
Workflows for developers
Webhook triggers
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
Enterprise
Overview
Single-workspace apps
Overview
Preparing your apps
Testing an Enterprise app
Organization-wide apps
Overview
Preparing for org-wide app deployment
OAuth & Installation for org-wide apps
Using APIs with org-wide apps
Migration
Reference
Legal Holds
Overview
Setup
Building Your App
Methods
Reference
Scopes
Entity Types
Restrictions
Errors
Pagination
Apps for Admins
Overview
User management
Creating workspaces and managing users
Manging invite requests
Resetting user sessions
Provisioning with SCIM
Workspace management
Managing channels
Managing app approvals
Security
Monitoring audit events
Monitoring anomaly events
Calling the Audit Logs API
Gov Slack
Partners
Reference
Translated content
日本語版ページ
Stay updated
Recent updates
Developer blog
@SlackAPI
Tools and resources
Our tools
Get support
Partner with us
API Terms of Service
Slack Fund
FAQ
Slack Engineering
Community
Community Discussion
Tools and resources
Groups and events
Code of Conduct
Hosting providers
Reference
Docs and feature guides
Automating Slack with workflows
Automation
Overview
Introduction
Quickstart
Samples & templates
Give us feedback
Building Run On Slack apps
Create or remove an app
App manifest
Environment variables
Slack functions
Custom functions
Testing custom functions
Workflows
Security
Bolt for next generation Slack apps
Triggering workflows
Triggers overview
Link triggers
Scheduled triggers
Event triggers
Webhook triggers
Trigger management
Working with APIs
Slack API methods
External authentication
Working with data
Datastores
Built-in types
Custom types
Message metadata events
Interactivity
Using forms
Block Kit interactivity
Modal View interactivity
Deploying apps
Local development
Deploy to Slack
Permissions control for admins
Team collaboration
Guided tutorials
Extras
FAQ
Changelog
Translated content
🇯🇵
Slack CLI
Install & authorize
Commands
CLI quick reference
Logging
Error troubleshooting
Customizing Slack with apps
Start learning
Overview
Intro to the Slack platform
Planning your app
Overview
Plotting interactions
Choosing the right APIs
Communicating with users
Interaction guidelines
Designing a great experience
Overview
Home tab guidelines
Modal guidelines
Shortcut guidelines
Choosing voice and tone
Localizing apps
Onboarding users
General guidelines
Building an app
Overview
Building with Bolt
Developing with Bolt for Python
Developing with Bolt for Java
Workflow Builder
Block Kit Builder
SDKs and tools
App blueprints
Distributing an app
Overview
Building for the App Directory
App Directory Review Guide
App Directory Guidelines
App directory checklist
Distributing apps publicly
Authentication
Overview
Installation & Permissions
Basic app setup
Installing with OAuth
Quickstart: what's new
Migration guide
Token rotation
Security
Verifying requests
Best practices
Access tokens
Token types
Configuration tokens
Sign in with Slack
Get started with Sign in with Slack
Sign in with Slack links
SIWS links using Auth0
Reference
Scopes
Messaging
Overview
Managing messages
Overview
Retrieving messages
Sending messages
Modifying messages
Scheduling messages
Using Webhooks
Composing messages
Overview
Formatting text
Rich message layouts
Interactive messages
Block Kit Builder
Working with files
Overview
Uploading files
Adding remote files
Reference
Message payloads
Block kit reference
Secondary attachments
Unfurling links in messages
Upgrading to blocks
Metadata
Overview
Using metadata
Metadata events
message_metadata_posted
message_metadata_updated
message_metadata_deleted
Event scope
Metadata schemas
Surfaces
Overview
Home tabs
Overview
Using your Home tab
Events in App Home
Modals
Overview
Using modals
Messages
Reference
Defining views
Block Kit
Overview
Building with Block Kit
Interactivity in Block Kit
Block Kit builder
App templates
Reference
Overview
Layout blocks
Block elements
Interactive components
Composition objects
Defining views
block_actions payloads
View interaction payloads
Upgrading to modals
Accessibility
Interactivity
Overview
Handling user interaction
Entry points
Shortcuts
Slash Commands
Interaction payloads
Overview
Shortcuts payloads
block_actions payloads
View interaction payloads
APIs
Overview
Connection protocols
Overview
Using the Events API over HTTP
Intro to Socket Mode
Socket Mode implementation
Usage guides
Using the Web API
Overview
Pagination
Rate limits
Calls API
Presence & status
Bookmarks API
Slack Connect
Overview
Slack Connect APIs
Status API
Reference
Methods
Event types
Object types
Workflows
Overview
Workflows for users
Pre-built workflows
Workflows for developers
Webhook triggers
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
Enterprise
Overview
Single-workspace apps
Overview
Preparing your apps
Testing an Enterprise app
Organization-wide apps
Overview
Preparing for org-wide app deployment
OAuth & Installation for org-wide apps
Using APIs with org-wide apps
Migration
Reference
Legal Holds
Overview
Setup
Building Your App
Methods
Reference
Scopes
Entity Types
Restrictions
Errors
Pagination
Apps for Admins
Overview
User management
Creating workspaces and managing users
Manging invite requests
Resetting user sessions
Provisioning with SCIM
Workspace management
Managing channels
Managing app approvals
Security
Monitoring audit events
Monitoring anomaly events
Calling the Audit Logs API
Gov Slack
Partners
Reference
Translated content
日本語版ページ
Stay updated
Recent updates
Developer blog
@SlackAPI
Tools and resources
Our tools
Get support
Partner with us
API Terms of Service
Slack Fund
FAQ
Slack Engineering
Community
Community Discussion
Tools and resources
Groups and events
Code of Conduct
Hosting providers
Tutorials
Tutorials
Hello World
Give Kudos
Welcome Bot
GitHub Issue
Announcement Bot
Virtual Running Buddies
Request Time Off
Open Authorization
Your apps
Sign in to Slack to manage apps
Automating Slack with workflows
Automation
Overview
Introduction
Quickstart
Samples & templates
Give us feedback
Building Run On Slack apps
Create or remove an app
App manifest
Environment variables
Slack functions
Custom functions
Testing custom functions
Workflows
Security
Bolt for next generation Slack apps
Triggering workflows
Triggers overview
Link triggers
Scheduled triggers
Event triggers
Webhook triggers
Trigger management
Working with APIs
Slack API methods
External authentication
Working with data
Datastores
Built-in types
Custom types
Message metadata events
Interactivity
Using forms
Block Kit interactivity
Modal View interactivity
Deploying apps
Local development
Deploy to Slack
Permissions control for admins
Team collaboration
Guided tutorials
Extras
FAQ
Changelog
Translated content
🇯🇵
Slack CLI
Install & authorize
Commands
CLI quick reference
Logging
Error troubleshooting
Customizing Slack with apps
Start learning
Overview
Intro to the Slack platform
Planning your app
Overview
Plotting interactions
Choosing the right APIs
Communicating with users
Interaction guidelines
Designing a great experience
Overview
Home tab guidelines
Modal guidelines
Shortcut guidelines
Choosing voice and tone
Localizing apps
Onboarding users
General guidelines
Building an app
Overview
Building with Bolt
Developing with Bolt for Python
Developing with Bolt for Java
Workflow Builder
Block Kit Builder
SDKs and tools
App blueprints
Distributing an app
Overview
Building for the App Directory
App Directory Review Guide
App Directory Guidelines
App directory checklist
Distributing apps publicly
Authentication
Overview
Installation & Permissions
Basic app setup
Installing with OAuth
Quickstart: what's new
Migration guide
Token rotation
Security
Verifying requests
Best practices
Access tokens
Token types
Configuration tokens
Sign in with Slack
Get started with Sign in with Slack
Sign in with Slack links
SIWS links using Auth0
Reference
Scopes
Messaging
Overview
Managing messages
Overview
Retrieving messages
Sending messages
Modifying messages
Scheduling messages
Using Webhooks
Composing messages
Overview
Formatting text
Rich message layouts
Interactive messages
Block Kit Builder
Working with files
Overview
Uploading files
Adding remote files
Reference
Message payloads
Block kit reference
Secondary attachments
Unfurling links in messages
Upgrading to blocks
Metadata
Overview
Using metadata
Metadata events
message_metadata_posted
message_metadata_updated
message_metadata_deleted
Event scope
Metadata schemas
Surfaces
Overview
Home tabs
Overview
Using your Home tab
Events in App Home
Modals
Overview
Using modals
Messages
Reference
Defining views
Block Kit
Overview
Building with Block Kit
Interactivity in Block Kit
Block Kit builder
App templates
Reference
Overview
Layout blocks
Block elements
Interactive components
Composition objects
Defining views
block_actions payloads
View interaction payloads
Upgrading to modals
Accessibility
Interactivity
Overview
Handling user interaction
Entry points
Shortcuts
Slash Commands
Interaction payloads
Overview
Shortcuts payloads
block_actions payloads
View interaction payloads
APIs
Overview
Connection protocols
Overview
Using the Events API over HTTP
Intro to Socket Mode
Socket Mode implementation
Usage guides
Using the Web API
Overview
Pagination
Rate limits
Calls API
Presence & status
Bookmarks API
Slack Connect
Overview
Slack Connect APIs
Status API
Reference
Methods
Event types
Object types
Workflows
Overview
Workflows for users
Pre-built workflows
Workflows for developers
Webhook triggers
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
Enterprise
Overview
Single-workspace apps
Overview
Preparing your apps
Testing an Enterprise app
Organization-wide apps
Overview
Preparing for org-wide app deployment
OAuth & Installation for org-wide apps
Using APIs with org-wide apps
Migration
Reference
Legal Holds
Overview
Setup
Building Your App
Methods
Reference
Scopes
Entity Types
Restrictions
Errors
Pagination
Apps for Admins
Overview
User management
Creating workspaces and managing users
Manging invite requests
Resetting user sessions
Provisioning with SCIM
Workspace management
Managing channels
Managing app approvals
Security
Monitoring audit events
Monitoring anomaly events
Calling the Audit Logs API
Gov Slack
Partners
Reference
Translated content
日本語版ページ
Stay updated
Recent updates
Developer blog
@SlackAPI
Tools and resources
Our tools
Get support
Partner with us
API Terms of Service
Slack Fund
FAQ
Slack Engineering
Community
Community Discussion
Tools and resources
Groups and events
Code of Conduct
Hosting providers
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