@slack/web-api / Methods
Abstract Class: Methods
Defined in: packages/web-api/src/methods.ts:615
A class that defines all Web API methods, their arguments type, their response type, and binds those methods to the
apiCall class method.
Extends
EventEmitter<WebClientEvent>
Extended by
Properties
admin
readonly admin: object;
Defined in: packages/web-api/src/methods.ts:628
analytics
analytics: object;
analytics.getFile
getFile: MethodWithRequiredArgument<AdminAnalyticsGetFileArguments, AdminAnalyticsGetFileResponse>;
Description
Retrieve analytics data for a given date, presented as a compressed JSON file.
See
apps
apps: object;
apps.activities
activities: object;
apps.activities.list
list: Method<AdminAppsActivitiesListArguments, AdminAppsActivitiesListResponse>;
Description
Get logs for a specified team/org.
See
`admin.apps.activities.list` API reference.
apps.approve
approve: MethodWithRequiredArgument<AdminAppsApproveArguments, AdminAppsApproveResponse>;
Description
Approve an app for installation on a workspace.
See
`admin.apps.approve` API reference.
apps.approved
approved: object;
apps.approved.list
list: MethodWithRequiredArgument<AdminAppsApprovedListArguments, AdminAppsApprovedListResponse>;
Description
List approved apps for an org or workspace.
See
`admin.apps.approved.list` API reference.
apps.clearResolution
clearResolution: MethodWithRequiredArgument<AdminAppsClearResolutionArguments, AdminAppsClearResolutionResponse>;
Description
Clear an app resolution.
See
`admin.apps.clearResolution` API reference.
apps.config
config: object;
apps.config.lookup
lookup: MethodWithRequiredArgument<AdminAppsConfigLookupArguments, AdminAppsConfigLookupResponse>;
Description
Look up the app config for connectors by their IDs.
See
`admin.apps.config.lookup` API reference.
apps.config.set
set: MethodWithRequiredArgument<AdminAppsConfigSetArguments, AdminAppsConfigSetResponse>;
Description
Set the app config for a connector.
See
`admin.apps.config.set` API reference.
apps.requests
requests: object;
apps.requests.cancel
cancel: MethodWithRequiredArgument<AdminAppsRequestsCancelArguments, AdminAppsRequestsCancelResponse>;
Description
Cancel app request for team.
See
`admin.apps.requests.cancel` API reference.
apps.requests.list
list: MethodWithRequiredArgument<AdminAppsRequestsListArguments, AdminAppsRequestsListResponse>;
Description
List app requests for a team/workspace.
See
`admin.apps.requests.list` API reference.
apps.restrict
restrict: MethodWithRequiredArgument<AdminAppsRestrictArguments, AdminAppsRestrictResponse>;
Description
Restrict an app for installation on a workspace.
See
`admin.apps.restrict` API reference.
apps.restricted
restricted: object;
apps.restricted.list
list: MethodWithRequiredArgument<AdminAppsRestrictedListArguments, AdminAppsRestrictedListResponse>;
Description
List restricted apps for an org or workspace.
See
`admin.apps.restricted.list` API reference.
apps.uninstall
uninstall: MethodWithRequiredArgument<AdminAppsUninstallArguments, AdminAppsUninstallResponse>;
Description
Uninstall an app from one or many workspaces, or an entire enterprise organization.
See
`admin.apps.uninstall` API reference.
auth
auth: object;
auth.policy
policy: object;
auth.policy.assignEntities
assignEntities: MethodWithRequiredArgument<AdminAuthPolicyAssignEntitiesArguments, AdminAuthPolicyAssignEntitiesResponse>;
Description
Assign entities to a particular authentication policy.
See
`admin.auth.policy.assignEntities` API reference.
auth.policy.getEntities
getEntities: MethodWithRequiredArgument<AdminAuthPolicyGetEntitiesArguments, AdminAuthPolicyGetEntitiesResponse>;
Description
Fetch all the entities assigned to a particular authentication policy by name.
See
`admin.auth.policy.getEntities` API reference.
auth.policy.removeEntities
removeEntities: MethodWithRequiredArgument<AdminAuthPolicyRemoveEntitiesArguments, AdminAuthPolicyRemoveEntitiesResponse>;
Description
Remove specified entities from a specified authentication policy.
See
`admin.auth.policy.removeEntities` API reference.
barriers
barriers: object;
barriers.create
create: MethodWithRequiredArgument<AdminBarriersCreateArguments, AdminBarriersCreateResponse>;
Description
Create an Information Barrier.
See
`admin.barriers.create` API reference.
barriers.delete
delete: MethodWithRequiredArgument<AdminBarriersDeleteArguments, AdminBarriersDeleteResponse>;
Description
Delete an existing Information Barrier.
See
`admin.barriers.delete` API reference.
barriers.list
list: Method<AdminBarriersListArguments, AdminBarriersListResponse>;
Description
Get all Information Barriers for your organization.
See
`admin.barriers.list` API reference.
barriers.update
update: MethodWithRequiredArgument<AdminBarriersUpdateArguments, AdminBarriersUpdateResponse>;
Description
Update an existing Information Barrier.
See
`admin.barriers.update` API reference.
conversations
conversations: object;
conversations.archive
archive: MethodWithRequiredArgument<AdminConversationsArchiveArguments, AdminConversationsArchiveResponse>;
Description
Archive a public or private channel.
See
`admin.conversations.archive` API reference.
conversations.bulkArchive
bulkArchive: MethodWithRequiredArgument<AdminConversationsBulkArchiveArguments, AdminConversationsBulkArchiveResponse>;
Description
Archive public or private channels in bulk.
See
`admin.conversations.bulkArchive` API reference.
conversations.bulkDelete
bulkDelete: MethodWithRequiredArgument<AdminConversationsBulkDeleteArguments, AdminConversationsBulkDeleteResponse>;
Description
Delete public or private channels in bulk.
See
`admin.conversations.bulkDelete` API reference.
conversations.bulkMove
bulkMove: MethodWithRequiredArgument<AdminConversationsBulkMoveArguments, AdminConversationsBulkMoveResponse>;
Description
Move public or private channels in bulk.
See
`admin.conversations.bulkMove` API reference.
conversations.convertToPrivate
convertToPrivate: MethodWithRequiredArgument<AdminConversationsConvertToPrivateArguments, AdminConversationsConvertToPrivateResponse>;
Description
Convert a public channel to a private channel.
See
`admin.conversations.convertToPrivate` API reference.
conversations.convertToPublic
convertToPublic: MethodWithRequiredArgument<AdminConversationsConvertToPublicArguments, AdminConversationsConvertToPublicResponse>;
Description
Convert a private channel to a public channel.
See
`admin.conversations.convertToPublic` API reference.
conversations.create
create: MethodWithRequiredArgument<AdminConversationsCreateArguments, AdminConversationsCreateResponse>;
Description
Create a public or private channel-based conversation.
See
`admin.conversations.create` API reference.
conversations.delete
delete: MethodWithRequiredArgument<AdminConversationsDeleteArguments, AdminConversationsDeleteResponse>;
Description
Delete a public or private channel.
See
`admin.conversations.delete` API reference.
conversations.disconnectShared
disconnectShared: MethodWithRequiredArgument<AdminConversationsDisconnectSharedArguments, AdminConversationsDisconnectSharedResponse>;
Description
Disconnect a connected channel from one or more workspaces.
See
`admin.conversations.disconnectShared` API reference.
conversations.ekm
ekm: object;
conversations.ekm.listOriginalConnectedChannelInfo
listOriginalConnectedChannelInfo: Method<AdminConversationsEKMListOriginalConnectedChannelInfoArguments, AdminConversationsEkmListOriginalConnectedChannelInfoResponse>;
Description
List all disconnected channels — i.e., channels that were once connected to other workspaces and then disconnected — and the corresponding original channel IDs for key revocation with EKM.
See
`admin.conversations.ekm.listOriginalConnectedChannelInfo` API reference.
conversations.getConversationPrefs
getConversationPrefs: MethodWithRequiredArgument<AdminConversationsGetConversationPrefsArguments, AdminConversationsGetConversationPrefsResponse>;
Description
Get conversation preferences for a public or private channel.
See
`admin.conversations.getConversationPrefs` API reference.
conversations.getCustomRetention
getCustomRetention: MethodWithRequiredArgument<AdminConversationsGetCustomRetentionArguments, AdminConversationsGetCustomRetentionResponse>;
Description
Get a conversation's retention policy.
See
`admin.conversations.getCustomRetention` API reference.
conversations.getTeams
getTeams: MethodWithRequiredArgument<AdminConversationsGetTeamsArguments, AdminConversationsGetTeamsResponse>;
Description
Get all the workspaces a given public or private channel is connected to within this Enterprise org.
See
`admin.conversations.getTeams` API reference.
conversations.invite
invite: MethodWithRequiredArgument<AdminConversationsInviteArguments, AdminConversationsInviteResponse>;
Description
Invite a user to a public or private channel.
See
`admin.conversations.invite` API reference.
conversations.lookup
lookup: MethodWithRequiredArgument<AdminConversationsLookupArguments, AdminConversationsLookupResponse>;
Description
Returns channels on the given team using the filters.
See
`admin.conversations.lookup` API reference.
conversations.removeCustomRetention
removeCustomRetention: MethodWithRequiredArgument<AdminConversationsRemoveCustomRetentionArguments, AdminConversationsRemoveCustomRetentionResponse>;
Description
Remove a conversation's retention policy.
See
`admin.conversations.removeCustomRetention` API reference.
conversations.rename
rename: MethodWithRequiredArgument<AdminConversationsRenameArguments, AdminConversationsRenameResponse>;
Description
Rename a public or private channel.
See
`admin.conversations.rename` API reference.
conversations.restrictAccess
restrictAccess: object;
conversations.restrictAccess.addGroup
addGroup: MethodWithRequiredArgument<AdminConversationsRestrictAccessAddGroupArguments, AdminConversationsRestrictAccessAddGroupResponse>;
Description
Add an allowlist of IDP groups for accessing a channel.
See
`admin.conversations.restrictAccess.addGroup` API reference.
conversations.restrictAccess.listGroups
listGroups: MethodWithRequiredArgument<AdminConversationsRestrictAccessListGroupsArguments, AdminConversationsRestrictAccessListGroupsResponse>;
Description
List all IDP Groups linked to a channel.
See
`admin.conversations.restrictAccess.listGroups` API reference.
conversations.restrictAccess.removeGroup
removeGroup: MethodWithRequiredArgument<AdminConversationsRestrictAccessRemoveGroupArguments, AdminConversationsRestrictAccessRemoveGroupResponse>;
Description
Remove a linked IDP group linked from a private channel.
See
`admin.conversations.restrictAccess.removeGroup` API reference.
conversations.search
search: Method<AdminConversationsSearchArguments, AdminConversationsSearchResponse>;
Description
Search for public or private channels in an Enterprise organization.
See
`admin.conversations.search` API reference.
conversations.setConversationPrefs
setConversationPrefs: MethodWithRequiredArgument<AdminConversationsSetConversationPrefsArguments, AdminConversationsSetConversationPrefsResponse>;
Description
Set the posting permissions for a public or private channel.
See
`admin.conversations.setConversationPrefs` API reference.
conversations.setCustomRetention
setCustomRetention: MethodWithRequiredArgument<AdminConversationsSetCustomRetentionArguments, AdminConversationsSetCustomRetentionResponse>;
Description
Set a conversation's retention policy.
See
`admin.conversations.setCustomRetention` API reference.
conversations.setTeams
setTeams: MethodWithRequiredArgument<AdminConversationsSetTeamsArguments, AdminConversationsSetTeamsResponse>;
Description
Set the workspaces in an Enterprise grid org that connect to a public or private channel.
See
`admin.conversations.setTeams` API reference.
conversations.unarchive
unarchive: MethodWithRequiredArgument<AdminConversationsUnarchiveArguments, AdminConversationsUnarchiveResponse>;
Description
Unarchive a public or private channel.
See
`admin.conversations.unarchive` API reference.
emoji
emoji: object;
emoji.add
add: MethodWithRequiredArgument<AdminEmojiAddArguments, AdminEmojiAddResponse>;
Description
Add an emoji.
See
`admin.emoji.add` API reference.
emoji.addAlias
addAlias: MethodWithRequiredArgument<AdminEmojiAddAliasArguments, AdminEmojiAddAliasResponse>;
Description
Add an emoji alias.
See
`admin.emoji.addAlias` API reference.
emoji.list
list: Method<AdminEmojiListArguments, AdminEmojiListResponse>;
Description
List emoji for an Enterprise Grid organization.
See
`admin.emoji.list` API reference.
emoji.remove
remove: MethodWithRequiredArgument<AdminEmojiRemoveArguments, AdminEmojiRemoveResponse>;
Description
Remove an emoji across an Enterprise Grid organization.
See
`admin.emoji.remove` API reference.
emoji.rename
rename: MethodWithRequiredArgument<AdminEmojiRenameArguments, AdminEmojiRenameResponse>;
Description
Rename an emoji.
See
`admin.emoji.rename` API reference.
functions
functions: object;
functions.list
list: MethodWithRequiredArgument<AdminFunctionsListArguments, AdminFunctionsListResponse>;
Description
Look up functions by a set of apps.
See
`admin.functions.list` API reference.
functions.permissions
permissions: object;
functions.permissions.lookup
lookup: MethodWithRequiredArgument<AdminFunctionsPermissionsLookupArguments, AdminFunctionsPermissionsLookupResponse>;
Description
Lookup the visibility of multiple Slack functions and include the users if it is limited to particular named entities.
See
`admin.functions.permissions.lookup` API reference.
functions.permissions.set
set: MethodWithRequiredArgument<AdminFunctionsPermissionsSetArguments, AdminFunctionsPermissionsSetResponse>;
Description
Set the visibility of a Slack function and define the users or workspaces if it is set to named_entities.
See
`admin.functions.permissions.set` API reference.
inviteRequests
inviteRequests: object;
inviteRequests.approve
approve: MethodWithRequiredArgument<AdminInviteRequestsApproveArguments, AdminInviteRequestsApproveResponse>;
Description
Approve a workspace invite request.
See
`admin.inviteRequests.approve` API reference.
inviteRequests.approved
approved: object;
inviteRequests.approved.list
list: MethodWithRequiredArgument<AdminInviteRequestsApprovedListArguments, AdminInviteRequestsApprovedListResponse>;
Description
List all approved workspace invite requests.
See
`admin.inviteRequests.approved.list` API reference.
inviteRequests.denied
denied: object;
inviteRequests.denied.list
list: MethodWithRequiredArgument<AdminInviteRequestsDeniedListArguments, AdminInviteRequestsDeniedListResponse>;
Description
List all denied workspace invite requests.
See
`admin.inviteRequests.denied.list` API reference.
inviteRequests.deny
deny: MethodWithRequiredArgument<AdminInviteRequestsDenyArguments, AdminInviteRequestsDenyResponse>;
Description
Deny a workspace invite request.
See
`admin.inviteRequests.deny` API reference.
inviteRequests.list
list: MethodWithRequiredArgument<AdminInviteRequestsListArguments, AdminInviteRequestsListResponse>;
Description
List all pending workspace invite requests.
See
`admin.inviteRequests.list` API reference.
roles
roles: object;
roles.addAssignments
addAssignments: MethodWithRequiredArgument<AdminRolesAddAssignmentsArguments, AdminRolesAddAssignmentsResponse>;
Description
Adds members to the specified role with the specified scopes.
See
`admin.roles.addAssignments` API reference.
roles.listAssignments
listAssignments: Method<AdminRolesListAssignmentsArguments, AdminRolesListAssignmentsResponse>;
Description
Lists assignments for all roles across entities. Options to scope results by any combination of roles or entities.
See
`admin.roles.listAssignments` API reference.
roles.removeAssignments
removeAssignments: MethodWithRequiredArgument<AdminRolesRemoveAssignmentsArguments, AdminRolesRemoveAssignmentsResponse>;
Description
Removes a set of users from a role for the given scopes and entities.
See
`admin.roles.removeAssignments` API reference.
teams
teams: object;
teams.admins
admins: object;
teams.admins.list
list: MethodWithRequiredArgument<AdminTeamsAdminsListArguments, AdminTeamsAdminsListResponse>;
Description
List all of the admins on a given workspace.
See
`admin.teams.admins.list` API reference.
teams.create
create: MethodWithRequiredArgument<AdminTeamsCreateArguments, AdminTeamsCreateResponse>;
Description
Create an Enterprise team.
See
`admin.teams.create` API reference.
teams.list
list: Method<AdminTeamsListArguments, AdminTeamsListResponse>;
Description
List all teams on an Enterprise organization.
See
`admin.teams.list` API reference.
teams.owners
owners: object;
teams.owners.list
list: MethodWithRequiredArgument<AdminTeamsOwnersListArguments, AdminTeamsOwnersListResponse>;
Description
List all of the owners on a given workspace.
See
`admin.teams.owners.list` API reference.
teams.settings
settings: object;
teams.settings.info
info: MethodWithRequiredArgument<AdminTeamsSettingsInfoArguments, AdminTeamsSettingsInfoResponse>;
Description
Fetch information about settings in a workspace.
See
`admin.teams.settings.info` API reference.
teams.settings.setDefaultChannels
setDefaultChannels: MethodWithRequiredArgument<AdminTeamsSettingsSetDefaultChannelsArguments, AdminTeamsSettingsSetDefaultChannelsResponse>;
Description
Set the default channels of a workspace.
See
`admin.teams.settings.setDefaultChannels` API reference.
teams.settings.setDescription
setDescription: MethodWithRequiredArgument<AdminTeamsSettingsSetDescriptionArguments, AdminTeamsSettingsSetDescriptionResponse>;
Description
Set the description of a given workspace.
See
`admin.teams.settings.setDescription` API reference.
teams.settings.setDiscoverability
setDiscoverability: MethodWithRequiredArgument<AdminTeamsSettingsSetDiscoverabilityArguments, AdminTeamsSettingsSetDiscoverabilityResponse>;
Description
Set the discoverability of a given workspace.
See
`admin.teams.settings.setDiscoverability` API reference.
teams.settings.setIcon
setIcon: MethodWithRequiredArgument<AdminTeamsSettingsSetIconArguments, AdminTeamsSettingsSetIconResponse>;
Description
Sets the icon of a workspace.
See
`admin.teams.settings.setIcon` API reference.
teams.settings.setName
setName: MethodWithRequiredArgument<AdminTeamsSettingsSetNameArguments, AdminTeamsSettingsSetNameResponse>;
Description
Set the name of a given workspace.
See
`admin.teams.settings.setName` API reference.
usergroups
usergroups: object;
usergroups.addChannels
addChannels: MethodWithRequiredArgument<AdminUsergroupsAddChannelsArguments, AdminUsergroupsAddChannelsResponse>;
Description
Add up to one hundred default channels to an IDP group.
See
`admin.teams.usergroups.addChannels` API reference.
usergroups.addTeams
addTeams: MethodWithRequiredArgument<AdminUsergroupsAddTeamsArguments, AdminUsergroupsAddTeamsResponse>;
Description
Associate one or more default workspaces with an organization-wide IDP group.
See
`admin.teams.usergroups.addTeams` API reference.
usergroups.listChannels
listChannels: MethodWithRequiredArgument<AdminUsergroupsListChannelsArguments, AdminUsergroupsListChannelsResponse>;
Description
List the channels linked to an org-level IDP group (user group).
See
`admin.teams.usergroups.listChannels` API reference.
usergroups.removeChannels
removeChannels: MethodWithRequiredArgument<AdminUsergroupsRemoveChannelsArguments, AdminUsergroupsRemoveChannelsResponse>;
Description
Remove one or more default channels from an org-level IDP group (user group).
See
`admin.teams.usergroups.removeChannels` API reference.
users
users: object;
users.assign
assign: MethodWithRequiredArgument<AdminUsersAssignArguments, AdminUsersAssignResponse>;
Description
Add an Enterprise user to a workspace.
See
`admin.users.assign` API reference.
users.getExpiration
getExpiration: MethodWithRequiredArgument<AdminUsersGetExpirationArguments, AdminUsersGetExpirationResponse>;
Description
Fetches the expiration timestamp for a guest.
See
`admin.users.getExpiration` API reference.
users.invite
invite: MethodWithRequiredArgument<AdminUsersInviteArguments, AdminUsersInviteResponse>;
Description
Invite a user to a workspace.
See
`admin.users.invite` API reference.
users.list
list: Method<AdminUsersListArguments, AdminUsersListResponse>;
Description
List users on a workspace.
See
`admin.users.list` API reference.
users.remove
remove: MethodWithRequiredArgument<AdminUsersRemoveArguments, AdminUsersRemoveResponse>;
Description
Remove a user from a workspace.
See
`admin.users.remove` API reference.
users.session
session: object;
users.session.clearSettings
clearSettings: MethodWithRequiredArgument<AdminUsersSessionClearSettingsArguments, AdminUsersSessionClearSettingsResponse>;
Description
Clear user-specific session settings—the session duration and what happens when the client closes—for a list of users.
See
`admin.users.session.clearSettings` API reference.
users.session.getSettings
getSettings: MethodWithRequiredArgument<AdminUsersSessionGetSettingsArguments, AdminUsersSessionGetSettingsResponse>;
Description
Get user-specific session settings—the session duration and what happens when the client closes—given a list of users.
See
`admin.users.session.getSettings` API reference.
users.session.invalidate
invalidate: MethodWithRequiredArgument<AdminUsersSessionInvalidateArguments, AdminUsersSessionInvalidateResponse>;
Description
Revoke a single session for a user. The user will be forced to login to Slack.
See
`admin.users.session.invalidate` API reference.
users.session.list
list: Method<AdminUsersSessionListArguments, AdminUsersSessionListResponse>;
Description
List active user sessions for an organization.
See
`admin.users.session.list` API reference.
users.session.reset
reset: MethodWithRequiredArgument<AdminUsersSessionResetArguments, AdminUsersSessionResetResponse>;
Description
Wipes all valid sessions on all devices for a given user.
See
`admin.users.session.reset` API reference.
users.session.resetBulk
resetBulk: MethodWithRequiredArgument<AdminUsersSessionResetBulkArguments, AdminUsersSessionResetBulkResponse>;
Description
Enqueues an asynchronous job to wipe all valid sessions on all devices for a given user list.
See
`admin.users.session.resetBulk` API reference.
users.session.setSettings
setSettings: MethodWithRequiredArgument<AdminUsersSessionSetSettingsArguments, AdminUsersSessionSetSettingsResponse>;
Description
Configure the user-level session settings—the session duration and what happens when the client closes—for one or more users.
See
`admin.users.session.setSettings` API reference.
users.setAdmin
setAdmin: MethodWithRequiredArgument<AdminUsersSetAdminArguments, AdminUsersSetAdminResponse>;
Description
Set an existing guest, regular user, or owner to be an admin user.
See
`admin.users.setAdmin` API reference.
users.setExpiration
setExpiration: MethodWithRequiredArgument<AdminUsersSetExpirationArguments, AdminUsersSetExpirationResponse>;
Description
Set an expiration for a guest user.
See
`admin.users.setExpiration` API reference.
users.setOwner
setOwner: MethodWithRequiredArgument<AdminUsersSetOwnerArguments, AdminUsersSetOwnerResponse>;
Description
Set an existing guest, regular user, or admin user to be a workspace owner.
See
`admin.users.setOwner` API reference.
users.setRegular
setRegular: MethodWithRequiredArgument<AdminUsersSetRegularArguments, AdminUsersSetRegularResponse>;
Description
Set an existing guest user, admin user, or owner to be a regular user.
See
`admin.users.setRegular` API reference.
users.unsupportedVersions
unsupportedVersions: object;
users.unsupportedVersions.export
export: MethodWithRequiredArgument<AdminUsersUnsupportedVersionsExportArguments, AdminUsersUnsupportedVersionsExportResponse>;
Description
Ask Slackbot to send you an export listing all workspace members using unsupported software, presented as a zipped CSV file.
See
`admin.users.unsupportedVersions.export` API reference.
workflows
workflows: object;
workflows.collaborators
collaborators: object;
workflows.collaborators.add
add: MethodWithRequiredArgument<AdminWorkflowsCollaboratorsAddArguments, AdminWorkflowsCollaboratorsAddResponse>;
Description
Add collaborators to workflows within the team or enterprise.
See
`admin.workflows.collaborators.add` API reference.
workflows.collaborators.remove
remove: MethodWithRequiredArgument<AdminWorkflowsCollaboratorsRemoveArguments, AdminWorkflowsCollaboratorsRemoveResponse>;
Description
Remove collaborators from workflows within the team or enterprise.
See
`admin.workflows.collaborators.remove` API reference.
workflows.permissions
permissions: object;
workflows.permissions.lookup
lookup: MethodWithRequiredArgument<AdminWorkflowsPermissionsLookupArguments, AdminWorkflowsPermissionsLookupResponse>;
Description
Look up the permissions for a set of workflows.
See
`admin.workflows.permissions.lookup` API reference.
workflows.search
search: Method<AdminWorkflowsSearchArguments, AdminWorkflowsSearchResponse>;
Description
Search workflows within the team or enterprise.
See
`admin.workflows.search` API reference.
workflows.unpublish
unpublish: MethodWithRequiredArgument<AdminWorkflowsUnpublishArguments, AdminWorkflowsUnpublishResponse>;
Description
Unpublish workflows within the team or enterprise.
See
`admin.workflows.unpublish` API reference.
agents
readonly agents: object;
Defined in: packages/web-api/src/methods.ts:1401
conversations
conversations: object;
conversations.archive
archive: MethodWithRequiredArgument<AgentsConversationsArchiveArguments, AgentsConversationsArchiveResponse>;
Description
Archive a code channel.
See
`agents.conversations.archive` API reference.
conversations.create
create: MethodWithRequiredArgument<AgentsConversationsCreateArguments, AgentsConversationsCreateResponse>;
Description
Create a dedicated code channel for an agent session.
See
`agents.conversations.create` API reference.
conversations.getCanvas
getCanvas: MethodWithRequiredArgument<AgentsConversationsGetCanvasArguments, AgentsConversationsGetCanvasResponse>;
Description
Fetch a canvas attached to a code channel.
See
`agents.conversations.getCanvas` API reference.
conversations.listViews
listViews: MethodWithRequiredArgument<AgentsConversationsListViewsArguments, AgentsConversationsListViewsResponse>;
Description
List the views currently attached to a code channel.
See
`agents.conversations.listViews` API reference.
conversations.removeView
removeView: MethodWithRequiredArgument<AgentsConversationsRemoveViewArguments, AgentsConversationsRemoveViewResponse>;
Description
Remove a view from a code channel.
See
`agents.conversations.removeView` API reference.
conversations.setCanvasContent
setCanvasContent: MethodWithRequiredArgument<AgentsConversationsSetCanvasContentArguments, AgentsConversationsSetCanvasContentResponse>;
Description
Replace the full markdown content of a plan canvas attached to a code channel.
See
`agents.conversations.setCanvasContent` API reference.
conversations.setCommands
setCommands: MethodWithRequiredArgument<AgentsConversationsSetCommandsArguments, AgentsConversationsSetCommandsResponse>;
Description
Register the set of agent-defined slash commands for the calling agent in a code channel.
See
`agents.conversations.setCommands` API reference.
conversations.setProperties
setProperties: MethodWithRequiredArgument<AgentsConversationsSetPropertiesArguments, AgentsConversationsSetPropertiesResponse>;
Description
Set properties on a code channel.
See
`agents.conversations.setProperties` API reference.
conversations.setView
setView: MethodWithRequiredArgument<AgentsConversationsSetViewArguments, AgentsConversationsSetViewResponse>;
Description
Create or update a view in a code channel.
See
`agents.conversations.setView` API reference.
sessions
sessions: object;
sessions.rename
rename: MethodWithRequiredArgument<AgentsSessionsRenameArguments, AgentsSessionsRenameResponse>;
Description
Rename an agent session.
See
`agents.sessions.rename` API reference.
sessions.setStatus
setStatus: MethodWithRequiredArgument<AgentsSessionsSetStatusArguments, AgentsSessionsSetStatusResponse>;
Description
Set an agent session's lifecycle status, creating the session if needed.
See
`agents.sessions.setStatus` API reference.
api
readonly api: object;
Defined in: packages/web-api/src/methods.ts:1493
test
test: Method<APITestArguments, ApiTestResponse>;
Description
Checks API calling code.
See
apps
readonly apps: object;
Defined in: packages/web-api/src/methods.ts:1530
connections
connections: object;
connections.open
open: Method<AppsConnectionsOpenArguments, AppsConnectionsOpenResponse>;
Description
Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive events and interactive payloads over.
See
`apps.connections.open` API reference.
event
event: object;
event.authorizations
authorizations: object;
event.authorizations.list
list: MethodWithRequiredArgument<AppsEventAuthorizationsListArguments, AppsEventAuthorizationsListResponse>;
Description
Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.
See
`apps.event.authorizations.list` API reference.
manifest
manifest: object;
manifest.create
create: MethodWithRequiredArgument<AppsManifestCreateArguments, AppsManifestCreateResponse>;
Description
Create an app from an app manifest.
See
`apps.manifest.create` API reference.
manifest.delete
delete: MethodWithRequiredArgument<AppsManifestDeleteArguments, AppsManifestDeleteResponse>;
Description
Permanently deletes an app created through app manifests.
See
`apps.manifest.delete` API reference.
manifest.export
export: MethodWithRequiredArgument<AppsManifestExportArguments, AppsManifestExportResponse>;
Description
Export an app manifest from an existing app.
See
`apps.manifest.export` API reference.
manifest.update
update: MethodWithRequiredArgument<AppsManifestUpdateArguments, AppsManifestUpdateResponse>;
Description
Update an app from an app manifest.
See
`apps.manifest.update` API reference.
manifest.validate
validate: MethodWithRequiredArgument<AppsManifestValidateArguments, AppsManifestValidateResponse>;
Description
Validate an app manifest.
See
`apps.manifest.validate` API reference.
uninstall
uninstall: MethodWithRequiredArgument<AppsUninstallArguments, AppsUninstallResponse>;
Description
Uninstalls your app from a workspace.
See
`apps.uninstall` API reference.
user
user: object;
user.connection
connection: object;
user.connection.update
update: MethodWithRequiredArgument<AppsUserConnectionUpdateArguments, AppsUserConnectionUpdateResponse>;
Description
Updates the connection status between a user and an app.
See
`apps.user.connection.update` API reference.
assistant
readonly assistant: object;
Defined in: packages/web-api/src/methods.ts:1501
threads
threads: object;
threads.setStatus
setStatus: MethodWithRequiredArgument<AssistantThreadsSetStatusArguments, AssistantThreadsSetStatusResponse>;
Description
Set loading status to indicate that the app is building a response.
See
`assistant.threads.setStatus` API reference.
threads.setSuggestedPrompts
setSuggestedPrompts: MethodWithRequiredArgument<AssistantThreadsSetSuggestedPromptsArguments, AssistantThreadsSetSuggestedPromptsResponse>;
Description
Set suggested prompts for the user. Can suggest up to four prompts.
See
`assistant.threads.setSuggestedPrompts` API reference.
threads.setTitle
setTitle: MethodWithRequiredArgument<AssistantThreadsSetTitleArguments, AssistantThreadsSetTitleResponse>;
Description
Set the title of the thread. This is shown when a user views the app's chat history.
See
`assistant.threads.setTitle` API reference.
auth
readonly auth: object;
Defined in: packages/web-api/src/methods.ts:1604
revoke
revoke: Method<AuthRevokeArguments, AuthRevokeResponse>;
Description
Revokes a token.
See
teams
teams: object;
teams.list
list: Method<AuthTeamsListArguments, AuthTeamsListResponse>;
Description
Obtain a full list of workspaces your org-wide app has been approved for.
See
`auth.teams.list` API reference.
test
test: Method<AuthTestArguments, AuthTestResponse>;
blocks
readonly blocks: object;
Defined in: packages/web-api/src/methods.ts:1643
validate
validate: Method<BlocksValidateArguments, BlocksValidateResponse>;
Description
Validates blocks, messages, and views Block Kit JSON payloads.
See
`blocks.validate` API reference.
bookmarks
readonly bookmarks: object;
Defined in: packages/web-api/src/methods.ts:1620
add
add: MethodWithRequiredArgument<BookmarksAddArguments, BookmarksAddResponse>;
Description
Add bookmark to a channel.
See
`bookmarks.add` API reference.
edit
edit: MethodWithRequiredArgument<BookmarksEditArguments, BookmarksEditResponse>;
Description
Edit bookmark.
See
`bookmarks.edit` API reference.
list
list: MethodWithRequiredArgument<BookmarksListArguments, BookmarksListResponse>;
Description
List bookmarks for a channel.
See
`bookmarks.list` API reference.
remove
remove: MethodWithRequiredArgument<BookmarksRemoveArguments, BookmarksRemoveResponse>;
Description
Remove bookmark from a channel.
See
`bookmarks.remove` API reference.
bots
readonly bots: object;
Defined in: packages/web-api/src/methods.ts:1651
info
info: Method<BotsInfoArguments, BotsInfoResponse>;
Description
Gets information about a bot user.
See
calls
readonly calls: object;
Defined in: packages/web-api/src/methods.ts:1659
add
add: MethodWithRequiredArgument<CallsAddArguments, CallsAddResponse>;
Description
Registers a new Call.
See
end
end: MethodWithRequiredArgument<CallsEndArguments, CallsEndResponse>;
Description
Ends a Call.
See
info
info: MethodWithRequiredArgument<CallsInfoArguments, CallsInfoResponse>;
Description
Returns information about a Call.
See
participants
participants: object;
participants.add
add: MethodWithRequiredArgument<CallsParticipantsAddArguments, CallsParticipantsAddResponse>;
Description
Registers new participants added to a Call.
See
`calls.participants.add` API reference.
participants.remove
remove: MethodWithRequiredArgument<CallsParticipantsRemoveArguments, CallsParticipantsRemoveResponse>;
update
update: MethodWithRequiredArgument<CallsUpdateArguments, CallsUpdateResponse>;
Description
Updates information about a Call.
See
canvases
readonly canvases: object;
Defined in: packages/web-api/src/methods.ts:1693
access
access: object;
access.delete
delete: MethodWithRequiredArgument<CanvasesAccessDeleteArguments, CanvasesAccessDeleteResponse>;
Description
Remove access to a canvas for specified entities.
See
`canvases.access.delete` API reference.
access.set
set: MethodWithRequiredArgument<CanvasesAccessSetArguments, CanvasesAccessSetResponse>;
Description
Sets the access level to a canvas for specified entities.
See
`canvases.access.set` API reference.
create
create: Method<CanvasesCreateArguments, CanvasesCreateResponse>;
Description
Create Canvas for a user.
See
`canvases.create` API reference.
delete
delete: MethodWithRequiredArgument<CanvasesDeleteArguments, CanvasesDeleteResponse>;
Description
Deletes a canvas.
See
`canvases.delete` API reference.
edit
edit: MethodWithRequiredArgument<CanvasesEditArguments, CanvasesEditResponse>;
Description
Update an existing canvas.
See
`canvases.edit` API reference.
sections
sections: object;
sections.lookup
lookup: MethodWithRequiredArgument<CanvasesSectionsLookupArguments, CanvasesSectionsLookupResponse>;
Description
Find sections matching the provided criteria.
See
`canvases.sections.lookup` API reference.
chat
readonly chat: object;
Defined in: packages/web-api/src/methods.ts:1733
appendStream
appendStream: MethodWithRequiredArgument<ChatAppendStreamArguments, ChatAppendStreamResponse>;
Description
Appends text to an existing streaming conversation.
See
`chat.appendStream` API reference.
delete
delete: MethodWithRequiredArgument<ChatDeleteArguments, ChatDeleteResponse>;
Description
Deletes a message.
See
deleteScheduledMessage
deleteScheduledMessage: MethodWithRequiredArgument<ChatDeleteScheduledMessageArguments, ChatDeleteScheduledMessageResponse>;
Description
Deletes a pending scheduled message from the queue.
See
`chat.deleteScheduledMessage` API reference.
getPermalink
getPermalink: MethodWithRequiredArgument<ChatGetPermalinkArguments, ChatGetPermalinkResponse>;
Description
Retrieve a permalink URL for a specific extant message.
See
`chat.getPermalink` API reference.
meMessage
meMessage: MethodWithRequiredArgument<ChatMeMessageArguments, ChatMeMessageResponse>;
Description
Share a me message into a channel.
See
`chat.meMessage` API reference.
postEphemeral
postEphemeral: MethodWithRequiredArgument<ChatPostEphemeralArguments, ChatPostEphemeralResponse>;
Description
Sends an ephemeral message to a user in a channel.
See
`chat.postEphemeral` API reference.
postMessage
postMessage: MethodWithRequiredArgument<ChatPostMessageArguments, ChatPostMessageResponse>;
Description
Sends a message to a channel.
See
`chat.postMessage` API reference.
scheduledMessages
scheduledMessages: object;
scheduledMessages.list
list: Method<ChatScheduledMessagesListArguments, ChatScheduledMessagesListResponse>;
Description
Returns a list of scheduled messages.
See
`chat.scheduledMessages.list` API reference.
scheduleMessage
scheduleMessage: MethodWithRequiredArgument<ChatScheduleMessageArguments, ChatScheduleMessageResponse>;
Description
Schedules a message to be sent to a channel.
See
`chat.scheduleMessage` API reference.
startStream
startStream: MethodWithRequiredArgument<ChatStartStreamArguments, ChatStartStreamResponse>;
Description
Starts a new streaming conversation.
See
`chat.startStream` API reference.
stopStream
stopStream: MethodWithRequiredArgument<ChatStopStreamArguments, ChatStopStreamResponse>;
Description
Stops a streaming conversation.
See
`chat.stopStream` API reference.
unfurl
unfurl: MethodWithRequiredArgument<ChatUnfurlArguments, ChatUnfurlResponse>;
Description
Provide custom unfurl behavior for user-posted URLs.
See
update
update: MethodWithRequiredArgument<ChatUpdateArguments, ChatUpdateResponse>;
Description
Updates a message.
See
conversations
readonly conversations: object;
Defined in: packages/web-api/src/methods.ts:1812
acceptSharedInvite
acceptSharedInvite: MethodWithRequiredArgument<ConversationsAcceptSharedInviteArguments, ConversationsAcceptSharedInviteResponse>;
Description
Accepts an invitation to a Slack Connect channel.
See
`conversations.acceptSharedInvite` API reference.
approveSharedInvite
approveSharedInvite: MethodWithRequiredArgument<ConversationsApproveSharedInviteArguments, ConversationsApproveSharedInviteResponse>;
Description
Approves an invitation to a Slack Connect channel.
See
`conversations.approveSharedInvite` API reference.
archive
archive: MethodWithRequiredArgument<ConversationsArchiveArguments, ConversationsArchiveResponse>;
Description
Archives a conversation.
See
`conversations.archive` API reference.
canvases
canvases: object;
canvases.create
create: MethodWithRequiredArgument<ConversationsCanvasesCreateArguments, ConversationsCanvasesCreateResponse>;
Description
Create a Channel Canvas for a channel.
See
`conversations.canvases.create` API reference.
close
close: MethodWithRequiredArgument<ConversationsCloseArguments, ConversationsCloseResponse>;
Description
Closes a direct message or multi-person direct message.
See
`conversations.close` API reference.
create
create: MethodWithRequiredArgument<ConversationsCreateArguments, ConversationsCreateResponse>;
Description
Initiates a public or private channel-based conversation.
See
`conversations.create` API reference.
declineSharedInvite
declineSharedInvite: MethodWithRequiredArgument<ConversationsDeclineSharedInviteArguments, ConversationsDeclineSharedInviteResponse>;
Description
Declines an invitation to a Slack Connect channel.
See
`conversations.declineSharedInvite` API reference.
externalInvitePermissions
externalInvitePermissions: object;
externalInvitePermissions.set
set: MethodWithRequiredArgument<ConversationsExternalInvitePermissionsSetArguments, ConversationsExternalInvitePermissionsSetResponse>;
Description
Convert a team in a shared channel from an External Limited channel to a fully shared Slack Connect channel or vice versa.
See
`conversations.externalInvitePermissions.set` API reference.
history
history: MethodWithRequiredArgument<ConversationsHistoryArguments, ConversationsHistoryResponse>;
Description
Fetches a conversation's history of messages and events.
See
`conversations.history` API reference.
info
info: MethodWithRequiredArgument<ConversationsInfoArguments, ConversationsInfoResponse>;
Description
Retrieve information about a conversation.
See
`conversations.info` API reference.
invite
invite: MethodWithRequiredArgument<ConversationsInviteArguments, ConversationsInviteResponse>;
Description
Invites users to a channel.
See
`conversations.invite` API reference.
inviteShared
inviteShared: MethodWithRequiredArgument<ConversationsInviteSharedArguments, ConversationsInviteSharedResponse>;
Description
Sends an invitation to a Slack Connect channel.
See
`conversations.inviteShared` API reference.
join
join: MethodWithRequiredArgument<ConversationsJoinArguments, ConversationsJoinResponse>;
Description
Joins an existing conversation.
See
`conversations.join` API reference.
kick
kick: MethodWithRequiredArgument<ConversationsKickArguments, ConversationsKickResponse>;
Description
Removes a user from a conversation.
See
`conversations.kick` API reference.
leave
leave: MethodWithRequiredArgument<ConversationsLeaveArguments, ConversationsLeaveResponse>;
Description
Leaves a conversation.
See
`conversations.leave` API reference.
list
list: Method<ConversationsListArguments, ConversationsListResponse>;
Description
List all channels in a Slack team.
See
`conversations.list` API reference.
listConnectInvites
listConnectInvites: Method<ConversationsListConnectInvitesArguments, ConversationsListConnectInvitesResponse>;
Description
Lists shared channel invites that have been generated or received but have not been approved by all parties.
See
`conversations.listConnectInvites` API reference.
mark
mark: MethodWithRequiredArgument<ConversationsMarkArguments, ConversationsMarkResponse>;
Description
Sets the read cursor in a channel.
See
`conversations.mark` API reference.
members
members: MethodWithRequiredArgument<ConversationsMembersArguments, ConversationsMembersResponse>;
Description
Retrieve members of a conversation.
See
`conversations.members` API reference.
open
open: MethodWithRequiredArgument<ConversationsOpenArguments, ConversationsOpenResponse>;
Description
Opens or resumes a direct message or multi-person direct message.
See
`conversations.open` API reference.
rename
rename: MethodWithRequiredArgument<ConversationsRenameArguments, ConversationsRenameResponse>;
Description
Renames a conversation.
See
`conversations.rename` API reference.
replies
replies: MethodWithRequiredArgument<ConversationsRepliesArguments, ConversationsRepliesResponse>;
Description
Retrieve a thread of messages posted to a conversation.
See
`conversations.replies` API reference.
requestSharedInvite
requestSharedInvite: object;
requestSharedInvite.approve
approve: MethodWithRequiredArgument<ConversationsRequestSharedInviteApproveArguments, ConversationsRequestSharedInviteApproveResponse>;
Description
Approves a request to add an external user to a channel and sends them a Slack Connect invite.
See
`conversations.requestSharedInvite.approve` API reference.
requestSharedInvite.deny
deny: MethodWithRequiredArgument<ConversationsRequestSharedInviteDenyArguments, ConversationsRequestSharedInviteDenyResponse>;
Description
Denies a request to invite an external user to a channel.
See
`conversations.requestSharedInvite.deny` API reference.
requestSharedInvite.list
list: Method<ConversationsRequestSharedInviteListArguments, ConversationsRequestSharedInviteListResponse>;
Description
Lists requests to add external users to channels with ability to filter.
See
`conversations.requestSharedInvite.list` API reference.
setPurpose
setPurpose: MethodWithRequiredArgument<ConversationsSetPurposeArguments, ConversationsSetPurposeResponse>;
Description
Sets the purpose for a conversation.
See
`conversations.setPurpose` API reference.
setTopic
setTopic: MethodWithRequiredArgument<ConversationsSetTopicArguments, ConversationsSetTopicResponse>;
Description
Sets the topic for a conversation.
See
`conversations.setTopic` API reference.
unarchive
unarchive: MethodWithRequiredArgument<ConversationsUnarchiveArguments, ConversationsUnarchiveResponse>;
Description
Reverses conversation archival.
See
`conversations.unarchive` API reference.
dialog
readonly dialog: object;
Defined in: packages/web-api/src/methods.ts:2005
open
open: MethodWithRequiredArgument<DialogOpenArguments, DialogOpenResponse>;
Description
Open a dialog with a user.
See
dnd
readonly dnd: object;
Defined in: packages/web-api/src/methods.ts:2013
endDnd
endDnd: Method<DndEndDndArguments, DndEndDndResponse>;
Description
Ends the current user's Do Not Disturb session immediately.
See
endSnooze
endSnooze: Method<DndEndSnoozeArguments, DndEndSnoozeResponse>;
Description
Ends the current user's snooze mode immediately.
See
`dnd.endSnooze` API reference.
info
info: Method<DndInfoArguments, DndInfoResponse>;
Description
Retrieves a user's current Do Not Disturb status.
See
setSnooze
setSnooze: MethodWithRequiredArgument<DndSetSnoozeArguments, DndSetSnoozeResponse>;
Description
Turns on Do Not Disturb mode for the current user, or changes its duration.
See
`dnd.setSnooze` API reference.
teamInfo
teamInfo: MethodWithRequiredArgument<DndTeamInfoArguments, DndTeamInfoResponse>;
Description
Retrieves the Do Not Disturb status for up to 50 users on a team.
See
emoji
readonly emoji: object;
Defined in: packages/web-api/src/methods.ts:2041
list
list: Method<EmojiListArguments, EmojiListResponse>;
Description
Lists custom emoji for a team.
See
entity
readonly entity: object;
Defined in: packages/web-api/src/methods.ts:2049
presentDetails
presentDetails: MethodWithRequiredArgument<EntityPresentDetailsArguments, EntityPresentDetailsResponse>;
Description
Provide information about the entity to be displayed in the flexpane.
See
https://docs.slack.dev/reference/methods/entity.presentDetails
files
readonly files: object;
Defined in: packages/web-api/src/methods.ts:2060
comments
comments: object;
comments.delete
delete: MethodWithRequiredArgument<FilesCommentsDeleteArguments, FilesCommentsDeleteResponse>;
Description
Deletes an existing comment on a file.
See
`files.comments.delete` API reference.
completeUploadExternal
completeUploadExternal: MethodWithRequiredArgument<FilesCompleteUploadExternalArguments, FilesCompleteUploadExternalResponse>;
Description
Finishes an upload started with `files.getUploadURLExternal`.
See
`files.completeUploadExternal` API reference.
delete
delete: MethodWithRequiredArgument<FilesDeleteArguments, FilesDeleteResponse>;
Description
Deletes a file.
See
getUploadURLExternal
getUploadURLExternal: MethodWithRequiredArgument<FilesGetUploadURLExternalArguments, FilesGetUploadURLExternalResponse>;
Description
Gets a URL for an edge external file upload.
See
`files.getUploadURLExternal` API reference.
info
info: MethodWithRequiredArgument<FilesInfoArguments, FilesInfoResponse>;
Description
Gets information about a file.
See
list
list: MethodWithRequiredArgument<FilesListArguments, FilesListResponse>;
Description
List files for a team, in a channel, or from a user with applied filters.
See
remote
remote: object;
remote.add
add: MethodWithRequiredArgument<FilesRemoteAddArguments, FilesRemoteAddResponse>;
Description
Adds a file from a remote service.
See
`files.remote.add` API reference.
remote.info
info: MethodWithRequiredArgument<FilesRemoteInfoArguments, FilesRemoteInfoResponse>;
Description
Retrieve information about a remote file added to Slack.
See
`files.remote.info` API reference.
remote.list
list: MethodWithRequiredArgument<FilesRemoteListArguments, FilesRemoteListResponse>;
Description
List remote files added to Slack.
See
`files.remote.list` API reference.
remote.remove
remove: MethodWithRequiredArgument<FilesRemoteRemoveArguments, FilesRemoteRemoveResponse>;
Description
Remove a remote file.
See
`files.remote.remove` API reference.
remote.share
share: MethodWithRequiredArgument<FilesRemoteShareArguments, FilesRemoteShareResponse>;
Description
Share a remote file into a channel.
See
`files.remote.share` API reference.
remote.update
update: MethodWithRequiredArgument<FilesRemoteUpdateArguments, FilesRemoteUpdateResponse>;
Description
Updates an existing remote file.
See
`files.remote.update` API reference.
revokePublicURL
revokePublicURL: MethodWithRequiredArgument<FilesRevokePublicURLArguments, FilesRevokePublicURLResponse>;
Description
Revokes public/external sharing access for a file.
See
`files.revokePublicURL` API reference.
sharedPublicURL
sharedPublicURL: MethodWithRequiredArgument<FilesSharedPublicURLArguments, FilesSharedPublicURLResponse>;
Description
Enables a file for public/external sharing.
See
`files.sharedPublicURL` API reference.
uploadV2
uploadV2: MethodWithRequiredArgument<FilesUploadV2Arguments, WebAPICallResult>;
Description
Custom method to support a new way of uploading files to Slack. Supports a single file upload Supply:
- (required) single file or content
- (optional) channel, alt_text, snippet_type, Supports multiple file uploads Supply:
- multiple upload_files Will try to honor both single file or content data supplied as well as multiple file uploads property.
See
`@slack/web-api` Upload a file documentation.
functions
readonly functions: object;
Defined in: packages/web-api/src/methods.ts:2163
completeError
completeError: MethodWithRequiredArgument<FunctionsCompleteErrorArguments, FunctionsCompleteErrorResponse>;
Description
Signal the failure to execute a Custom Function.
See
`functions.completeError` API reference.
completeSuccess
completeSuccess: MethodWithRequiredArgument<FunctionsCompleteSuccessArguments, FunctionsCompleteSuccessResponse>;
Description
Signal the successful completion of a Custom Function.
See
`functions.completeSuccess` API reference.
migration
readonly migration: object;
Defined in: packages/web-api/src/methods.ts:2182
exchange
exchange: MethodWithRequiredArgument<MigrationExchangeArguments, MigrationExchangeResponse>;
Description
For Enterprise Grid workspaces, map local user IDs to global user IDs.
See
`migration.exchange` API reference.
oauth
readonly oauth: object;
Defined in: packages/web-api/src/methods.ts:2190
access
access: MethodWithRequiredArgument<OAuthAccessArguments, OauthAccessResponse>;
Description
Exchanges a temporary OAuth verifier code for an access token.
Deprecated
This is a legacy method only used by classic Slack apps. Use oauth.v2.access for new Slack apps.
See
v2
v2: object;
v2.access
access: MethodWithRequiredArgument<OAuthV2AccessArguments, OauthV2AccessResponse>;
Description
Exchanges a temporary OAuth verifier code for an access token.
See
`oauth.v2.access` API reference.
v2.exchange
exchange: MethodWithRequiredArgument<OAuthV2ExchangeArguments, OauthV2ExchangeResponse>;
Description
Exchanges a legacy access token for a new expiring access token and refresh token.
See
`oauth.v2.exchange` API reference.
openid
readonly openid: object;
Defined in: packages/web-api/src/methods.ts:2211
connect
connect: object;
connect.token
token: MethodWithRequiredArgument<OpenIDConnectTokenArguments, OpenIDConnectTokenResponse>;
Description
Exchanges a temporary OAuth verifier code for an access token for Sign in with Slack.
See
`openid.connect.token` API reference.
connect.userInfo
userInfo: Method<OpenIDConnectUserInfoArguments, OpenIDConnectUserInfoResponse>;
Description
Get the identity of a user who has authorized Sign in with Slack.
See
`openid.connect.userInfo` API reference.
pins
readonly pins: object;
Defined in: packages/web-api/src/methods.ts:2229
add
add: MethodWithRequiredArgument<PinsAddArguments, PinsAddResponse>;
Description
Pins an item to a channel.
See
list
list: MethodWithRequiredArgument<PinsListArguments, PinsListResponse>;
Description
Lists items pinned to a channel.
See
remove
remove: MethodWithRequiredArgument<PinsRemoveArguments, PinsRemoveResponse>;
Description
Un-pins an item from a channel.
See
reactions
readonly reactions: object;
Defined in: packages/web-api/src/methods.ts:2247
add
add: MethodWithRequiredArgument<ReactionsAddArguments, ReactionsAddResponse>;
Description
Adds a reaction to an item.
See
`reactions.add` API reference.
get
get: MethodWithRequiredArgument<ReactionsGetArguments, ReactionsGetResponse>;
Description
Gets reactions for an item.
See
`reactions.get` API reference.
list
list: Method<ReactionsListArguments, ReactionsListResponse>;
Description
List reactions made by a user.
See
`reactions.list` API reference.
remove
remove: MethodWithRequiredArgument<ReactionsRemoveArguments, ReactionsRemoveResponse>;
Description
Removes a reaction from an item.
See
`reactions.remove` API reference.
reminders
readonly reminders: object;
Defined in: packages/web-api/src/methods.ts:2272
add
add: MethodWithRequiredArgument<RemindersAddArguments, RemindersAddResponse>;
Description
Creates a reminder.
See
`reminders.add` API reference.
complete
complete: MethodWithRequiredArgument<RemindersCompleteArguments, RemindersCompleteResponse>;
Description
Marks a reminder as complete.
See
`reminders.complete` API reference.
delete
delete: MethodWithRequiredArgument<RemindersDeleteArguments, RemindersDeleteResponse>;
Description
Deletes a reminder.
See
`reminders.delete` API reference.
info
info: MethodWithRequiredArgument<RemindersInfoArguments, RemindersInfoResponse>;
Description
Gets information about a reminder.
See
`reminders.info` API reference.
list
list: Method<RemindersListArguments, RemindersListResponse>;
Description
Lists all reminders created by or for a given user.
See
`reminders.list` API reference.
rtm
readonly rtm: object;
Defined in: packages/web-api/src/methods.ts:2300
connect
connect: Method<RTMConnectArguments, RtmConnectResponse>;
Description
Starts a Real Time Messaging session.
See
search
readonly search: object;
Defined in: packages/web-api/src/methods.ts:2308
all
all: MethodWithRequiredArgument<SearchAllArguments, SearchAllResponse>;
Description
Searches for messages and files matching a query.
See
files
files: MethodWithRequiredArgument<SearchFilesArguments, SearchFilesResponse>;
Description
Searches for files matching a query.
See
messages
messages: MethodWithRequiredArgument<SearchMessagesArguments, SearchMessagesResponse>;
Description
Searches for messages matching a query.
See
search.messages` API reference.
slackLists
readonly slackLists: object;
Defined in: packages/web-api/src/methods.ts:2326
access
access: object;
access.delete
delete: MethodWithRequiredArgument<SlackListsAccessDeleteArguments, SlackListsAccessDeleteResponse>;
Description
Delete access for specified entities.
See
`slackLists.access.delete` API reference.
access.set
set: MethodWithRequiredArgument<SlackListsAccessSetArguments, SlackListsAccessSetResponse>;
Description
Set access level for specified entities.
See
`slackLists.access.set` API reference.
create
create: MethodWithRequiredArgument<SlackListsCreateArguments, SlackListsCreateResponse>;
Description
Create a List.
See
`slackLists.create` API reference.
download
download: object;
download.get
get: MethodWithRequiredArgument<SlackListsDownloadGetArguments, SlackListsDownloadGetResponse>;
Description
Get download job status.
See
`slackLists.download.get` API reference.
download.start
start: MethodWithRequiredArgument<SlackListsDownloadStartArguments, SlackListsDownloadStartResponse>;
Description
Start a download job for a list.
See
`slackLists.download.start` API reference.
items
items: object;
items.create
create: MethodWithRequiredArgument<SlackListsItemsCreateArguments, SlackListsItemsCreateResponse>;
Description
Create a list item.
See
`slackLists.items.create` API reference.
items.delete
delete: MethodWithRequiredArgument<SlackListsItemsDeleteArguments, SlackListsItemsDeleteResponse>;
Description
Delete a list item.
See
`slackLists.items.delete` API reference.
items.deleteMultiple
deleteMultiple: MethodWithRequiredArgument<SlackListsItemsDeleteMultipleArguments, SlackListsItemsDeleteMultipleResponse>;
Description
Delete multiple list items.
See
`slackLists.items.deleteMultiple` API reference.
items.info
info: MethodWithRequiredArgument<SlackListsItemsInfoArguments, SlackListsItemsInfoResponse>;
Description
Get info about a list item.
See
`slackLists.items.info` API reference.
items.list
list: MethodWithRequiredArgument<SlackListsItemsListArguments, SlackListsItemsListResponse>;
Description
Get records from a List.
See
`slackLists.items.list` API reference.
items.update
update: MethodWithRequiredArgument<SlackListsItemsUpdateArguments, SlackListsItemsUpdateResponse>;
Description
Update a list item.
See
`slackLists.items.update` API reference.
update
update: MethodWithRequiredArgument<SlackListsUpdateArguments, SlackListsUpdateResponse>;
Description
Update a list.
See
`slackLists.update` API reference.
stars
readonly stars: object;
Defined in: packages/web-api/src/methods.ts:2636
add
add: MethodWithRequiredArgument<StarsAddRemoveArguments, StarsAddResponse>;
Description
Save an item for later. Formerly known as adding a star.
Deprecated
Stars can still be added but they can no longer be viewed or interacted with by end-users. See our post on stars and the Later list.
See
list
list: MethodWithRequiredArgument<StarsListArguments, StarsListResponse>;
Description
List a user's saved items, formerly known as stars.
Deprecated
Stars can still be listed but they can no longer be viewed or interacted with by end-users. See our post on stars and the Later list.
See
remove
remove: MethodWithRequiredArgument<StarsAddRemoveArguments, StarsRemoveResponse>;
Description
Remove a saved item from a user's saved items, formerly known as stars.
Deprecated
Stars can still be removed but they can no longer be viewed or interacted with by end-users. See our post on stars and the Later list.
See
team
readonly team: object;
Defined in: packages/web-api/src/methods.ts:2413
accessLogs
accessLogs: Method<TeamAccessLogsArguments, TeamAccessLogsResponse>;
Description
Gets the access logs for the current team.
See
`team.accessLogs` API reference.
billableInfo
billableInfo: Method<TeamBillableInfoArguments, TeamBillableInfoResponse>;
Description
Gets billable users information for the current team.
See
`team.billableInfo` API reference.
billing
billing: object;
billing.info
info: MethodWithRequiredArgument<TeamBillingInfoArguments, TeamBillingInfoResponse>;
Description
Reads a workspace's billing plan information.
See
`team.billing.info` API reference.
externalTeams
externalTeams: object;
externalTeams.disconnect
disconnect: MethodWithRequiredArgument<TeamExternalTeamsDisconnectArguments, TeamExternalTeamsDisconnectResponse>;
Description
Disconnect an external organization.
See
`team.externalTeams.disconnect` API reference.
externalTeams.list
list: MethodWithRequiredArgument<TeamExternalTeamsListArguments, TeamExternalTeamsListResponse>;
Description
Returns a list of all the external teams connected and details about the connection.
See
`team.externalTeams.list` API reference.
info
info: Method<TeamInfoArguments, TeamInfoResponse>;
Description
Gets information about the current team.
See
integrationLogs
integrationLogs: Method<TeamIntegrationLogsArguments, TeamIntegrationLogsResponse>;
Description
Gets the integration logs for the current team.
See
`team.integrationLogs` API reference.
preferences
preferences: object;
preferences.list
list: Method<TeamPreferencesListArguments, TeamPreferencesListResponse>;
Description
Retrieve a list of a workspace's team preferences.
See
`team.preferences.list` API reference.
profile
profile: object;
profile.get
get: Method<TeamProfileGetArguments, TeamProfileGetResponse>;
Description
Retrieve a team's profile.
See
`team.profile.get` API reference.
tooling
readonly tooling: object;
Defined in: packages/web-api/src/methods.ts:2484
tokens
tokens: object;
tokens.rotate
rotate: MethodWithRequiredArgument<ToolingTokensRotateArguments, ToolingTokensRotateResponse>;
Description
Exchanges a refresh token for a new app configuration token.
See
`tooling.tokens.rotate` API reference.
usergroups
readonly usergroups: object;
Defined in: packages/web-api/src/methods.ts:2494
create
create: MethodWithRequiredArgument<UsergroupsCreateArguments, UsergroupsCreateResponse>;
Description
Create a User Group.
See
`usergroups.create` API reference.
disable
disable: MethodWithRequiredArgument<UsergroupsDisableArguments, UsergroupsDisableResponse>;
Description
Disable an existing User Group.
See
`usergroups.disable` API reference.
enable
enable: MethodWithRequiredArgument<UsergroupsEnableArguments, UsergroupsEnableResponse>;
Description
Enable an existing User Group.
See
`usergroups.enable` API reference.
list
list: Method<UsergroupsListArguments, UsergroupsListResponse>;
Description
List all User Groups for a team.
See
`usergroups.list` API reference.
update
update: MethodWithRequiredArgument<UsergroupsUpdateArguments, UsergroupsUpdateResponse>;
Description
Update an existing User Group.
See
`usergroups.update` API reference.
users
users: object;
users.list
list: MethodWithRequiredArgument<UsergroupsUsersListArguments, UsergroupsUsersListResponse>;
Description
List all users in a User Group.
See
`usergroups.users.list` API reference.
users.update
update: MethodWithRequiredArgument<UsergroupsUsersUpdateArguments, UsergroupsUsersUpdateResponse>;
Description
Update the list of users in a User Group.
See
`usergroups.users.update` API reference.
users
readonly users: object;
Defined in: packages/web-api/src/methods.ts:2537
conversations
conversations: MethodWithRequiredArgument<UsersConversationsArguments, UsersConversationsResponse>;
Description
List conversations the calling user may access.
See
`users.conversations` API reference.
deletePhoto
deletePhoto: MethodWithRequiredArgument<UsersDeletePhotoArguments, UsersDeletePhotoResponse>;
Description
Delete the user profile photo.
See
`users.deletePhoto` API reference.
discoverableContacts
discoverableContacts: object;
discoverableContacts.lookup
lookup: MethodWithRequiredArgument<UsersDiscoverableContactsLookupArguments, UsersDiscoverableContactsLookupResponse>;
Description
Lookup an email address to see if someone is on Slack.
See
`users.discoverableContacts.lookup` API reference.
getPresence
getPresence: MethodWithRequiredArgument<UsersGetPresenceArguments, UsersGetPresenceResponse>;
Description
Gets user presence information.
See
`users.getPresence` API reference.
identity
identity: MethodWithRequiredArgument<UsersIdentityArguments, UsersIdentityResponse>;
Description
Get a user's identity.
See
`users.identity` API reference.
info
info: MethodWithRequiredArgument<UsersInfoArguments, UsersInfoResponse>;
Description
Gets information about a user.
See
list
list: MethodWithRequiredArgument<UsersListArguments, UsersListResponse>;
Description
Lists all users in a Slack team.
See
lookupByEmail
lookupByEmail: MethodWithRequiredArgument<UsersLookupByEmailArguments, UsersLookupByEmailResponse>;
Description
Find a user with an email address.
See
`users.lookupByEmail` API reference.
profile
profile: object;
profile.get
get: MethodWithRequiredArgument<UsersProfileGetArguments, UsersProfileGetResponse>;
Description
Retrieve a user's profile information, including their custom status.
See
`users.profile.get` API reference.
profile.set
set: MethodWithRequiredArgument<UsersProfileSetArguments, UsersProfileSetResponse>;
Description
Set a user's profile information, including custom status.
See
`users.profile.set` API reference.
setPhoto
setPhoto: MethodWithRequiredArgument<UsersSetPhotoArguments, UsersSetPhotoResponse>;
Description
Set the user profile photo.
See
`users.setPhoto` API reference.
setPresence
setPresence: MethodWithRequiredArgument<UsersSetPresenceArguments, UsersSetPresenceResponse>;
Description
Manually sets user presence.
See
`users.setPresence` API reference.
views
readonly views: object;
Defined in: packages/web-api/src/methods.ts:2607
open
open: MethodWithRequiredArgument<ViewsOpenArguments, ViewsOpenResponse>;
Description
Open a view for a user.
See
publish
publish: MethodWithRequiredArgument<ViewsPublishArguments, ViewsPublishResponse>;
Description
Publish a static view for a user.
See
`views.publish` API reference.
push
push: MethodWithRequiredArgument<ViewsPushArguments, ViewsPushResponse>;
Description
Push a view onto the stack of a root view.
See
update
update: MethodWithRequiredArgument<ViewsUpdateArguments, ViewsUpdateResponse>;
Description
Update an existing view.
See
workflows
readonly workflows: object;
Defined in: packages/web-api/src/methods.ts:2660
featured
featured: object;
featured.add
add: MethodWithRequiredArgument<WorkflowsFeaturedAddArguments, WorkflowsFeaturedAddResponse>;
Description
Add featured workflows to a channel.
See
`workflows.featured.add` API reference.
featured.list
list: MethodWithRequiredArgument<WorkflowsFeaturedListArguments, WorkflowsFeaturedListResponse>;
Description
List the featured workflows for specified channels.
See
`workflows.featured.list` API reference.
featured.remove
remove: MethodWithRequiredArgument<WorkflowsFeaturedRemoveArguments, WorkflowsFeaturedRemoveResponse>;
Description
Remove featured workflows from a channel.
See
`workflows.featured.remove` API reference.
featured.set
set: MethodWithRequiredArgument<WorkflowsFeaturedSetArguments, WorkflowsFeaturedSetResponse>;
Description
Set featured workflows for a channel.
See
`workflows.featured.set` API reference.
prefixed
static prefixed: string | boolean;
Defined in: node_modules/eventemitter3/index.d.ts:9
Inherited from
EventEmitter.prefixed
Methods
addListener()
addListener<T>(
event,
fn,
context?
): this;
Defined in: node_modules/eventemitter3/index.d.ts:45
Type Parameters
T
T extends RATE_LIMITED
Parameters
event
T
fn
(...args) => void
context?
any
Returns
this
Inherited from
EventEmitter.addListener
apiCall()
abstract apiCall(method, options?): Promise<WebAPICallResult>;
Defined in: packages/web-api/src/methods.ts:625
Parameters
method
string
options?
Record<string, unknown>
Returns
Promise<WebAPICallResult>
emit()
emit<T>(event, ...args): boolean;
Defined in: node_modules/eventemitter3/index.d.ts:32
Calls each of the listeners registered for a given event.
Type Parameters
T
T extends RATE_LIMITED
Parameters
event
T
args
...any[]
Returns
boolean
Inherited from
EventEmitter.emit
eventNames()
eventNames(): RATE_LIMITED[];
Defined in: node_modules/eventemitter3/index.d.ts:15
Return an array listing the events for which the emitter has registered listeners.
Returns
Inherited from
EventEmitter.eventNames
filesUploadV2()
abstract filesUploadV2(options): Promise<WebAPICallResult>;
Defined in: packages/web-api/src/methods.ts:626
Parameters
options
Returns
Promise<WebAPICallResult>
listenerCount()
listenerCount(event): number;
Defined in: node_modules/eventemitter3/index.d.ts:27
Return the number of listeners listening to a given event.
Parameters
event
Returns
number
Inherited from
EventEmitter.listenerCount
listeners()
listeners<T>(event): (...args) => void[];
Defined in: node_modules/eventemitter3/index.d.ts:20
Return the listeners registered for a given event.
Type Parameters
T
T extends RATE_LIMITED
Parameters
event
T
Returns
(...args) => void[]
Inherited from
EventEmitter.listeners
off()
off<T>(
event,
fn?,
context?,
once?
): this;
Defined in: node_modules/eventemitter3/index.d.ts:69
Type Parameters
T
T extends RATE_LIMITED
Parameters
event
T
fn?
(...args) => void
context?
any
once?
boolean
Returns
this
Inherited from
EventEmitter.off
on()
on<T>(
event,
fn,
context?
): this;
Defined in: node_modules/eventemitter3/index.d.ts:40
Add a listener for a given event.
Type Parameters
T
T extends RATE_LIMITED
Parameters
event
T
fn
(...args) => void
context?
any
Returns
this
Inherited from
EventEmitter.on
once()
once<T>(
event,
fn,
context?
): this;
Defined in: node_modules/eventemitter3/index.d.ts:54
Add a one-time listener for a given event.
Type Parameters
T
T extends RATE_LIMITED
Parameters
event
T
fn
(...args) => void
context?
any
Returns
this
Inherited from
EventEmitter.once
removeAllListeners()
removeAllListeners(event?): this;
Defined in: node_modules/eventemitter3/index.d.ts:79
Remove all listeners, or those of the specified event.
Parameters
event?
Returns
this
Inherited from
EventEmitter.removeAllListeners
removeListener()
removeListener<T>(
event,
fn?,
context?,
once?
): this;
Defined in: node_modules/eventemitter3/index.d.ts:63
Remove the listeners of a given event.
Type Parameters
T
T extends RATE_LIMITED
Parameters
event
T
fn?
(...args) => void
context?
any
once?
boolean
Returns
this
Inherited from
EventEmitter.removeListener