Class: WebClient
A client for Slack's Web API
This client provides an alias for each API method. Each method is a convenience wrapper for calling the WebClient#apiCall method using the method name as the first parameter.
Extends
Constructors
new WebClient()
new WebClient(token?, __namedParameters?): WebClient
Parameters
• token?: string
An API token to authenticate/authorize with Slack (usually start with xoxp
, xoxb
)
• __namedParameters?: WebClientOptions
= {}
Returns
Overrides
Defined in
packages/web-api/src/WebClient.ts:200
Properties
admin
readonly admin: object;
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<Partial<AppID> & Partial<TeamID> & TokenOverridable & CursorPaginationEnabled & object, 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<TokenOverridable & CursorPaginationEnabled, 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<Partial<TeamIDs> & TokenOverridable & CursorPaginationEnabled & Partial<ChannelIDs>, 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<SortDir & Partial<TeamIDs> & TokenOverridable & CursorPaginationEnabled & object, 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<TokenOverridable & CursorPaginationEnabled, 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<Partial<EntityIDs> & TokenOverridable & CursorPaginationEnabled & SortDir & object, 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<TokenOverridable & CursorPaginationEnabled, 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.owners.list
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.invite
invite: MethodWithRequiredArgument<AdminUsersInviteArguments, AdminUsersInviteResponse>;
Description
Invite a user to a workspace.
See
admin.users.invite
API reference.
users.list
list: Method<TeamIDOrDeactivatedWorkspaces & TokenOverridable & CursorPaginationEnabled & object, 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<EitherTeamAndUserIDOrNeither & TokenOverridable & CursorPaginationEnabled, 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<Partial<AppID> & Partial<CollaboratorIDs> & SortDir & TokenOverridable & CursorPaginationEnabled & object, 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.
Inherited from
Defined in
packages/web-api/src/methods.ts:562
api
readonly api: object;
test
test: Method<object, ApiTestResponse>;
Type declaration
error?
optional error: string;
Description
Error response to return.
Description
Checks API calling code.
See
Inherited from
Defined in
packages/web-api/src/methods.ts:1327
apps
readonly apps: object;
connections
connections: object;
connections.open
open: Method<object, 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
Inherited from
Defined in
packages/web-api/src/methods.ts:1335
auth
readonly auth: object;
revoke
revoke: Method<TokenOverridable & object, AuthRevokeResponse>;
Description
Revokes a token.
See
teams
teams: object;
teams.list
list: Method<TokenOverridable & CursorPaginationEnabled & object, 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<TokenOverridable, AuthTestResponse>;
Inherited from
Defined in
packages/web-api/src/methods.ts:1397
bookmarks
readonly bookmarks: object;
add
add: MethodWithRequiredArgument<BookmarksAddArguments, BookmarksAddResponse>;
Description
Add bookmark to a channel.
See
edit
edit: MethodWithRequiredArgument<BookmarksEditArguments, BookmarksEditResponse>;
Description
Edit bookmark.
See
list
list: MethodWithRequiredArgument<BookmarksListArguments, BookmarksListResponse>;
Description
List bookmarks for a channel.
See
remove
remove: MethodWithRequiredArgument<BookmarksRemoveArguments, BookmarksRemoveResponse>;
Description
Remove bookmark from a channel.
See
bookmarks.remove
API reference.
Inherited from
Defined in
packages/web-api/src/methods.ts:1413
bots
readonly bots: object;
info
info: Method<TokenOverridable & OptionalTeamAssignable & object, BotsInfoResponse>;
Description
Gets information about a bot user.
See
Inherited from
Defined in
packages/web-api/src/methods.ts:1436
calls
readonly calls: object;
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.