Module slack
ballerinax/slack Ballerina library
5.0.0
Overview
Slack is a collaboration platform for teams, offering real-time messaging, file sharing, and integrations with various tools. It helps streamline communication and enhance productivity through organized channels and direct messaging.
Setup guide
Step 1: Sign in to Slack
-
To use the Slack Connector you need to be signed in to Slack. If you haven't created an account already, you can create it here.
Step 2: Create a new Slack application
-
Navigate to your apps in Slack API and create a new Slack app.
-
Provide an app name and choose a workspace of your choice.
-
Click on the "Create App" button.
Step 3: Add scopes to the token
-
Once the application is created, go to the "Add Features and Functionality" section and click on "Permissions" to set the token scopes.
-
In the User Token Scopes section set the following token scopes.
-
Install the application to workspace.
-
Copy the OAuth token that is generated upon installation.
Quickstart
To use the slack connector in your Ballerina application, modify the .bal file as follows:
Step 1: Import the module
Import the slack module.
import ballerinax/slack;
Step 2: Instantiate a new connector
Assign the OAuth token obtained to the variable token, and then initialize a new instance of the slack client by passing the token.
configurable string token = ?; slack:Client slack = check new({ auth: { token } });
Step 3: Invoke the connector operation
Now, utilize the available connector operations.
Send a Text Message to General Channel
slack:ChatPostMessageResponse postMessageResponse = check slack->/chat\.postMessage.post({channel: "general", text: "hello"});
Step 4: Run the Ballerina application
bal run
Examples
The Slack connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
-
Automated Summary Report - This use case demonstrates how the Slack API can be utilized to generate a summarized report of daily stand up chats in the general channel.
-
Survey Feedback Analysis - This use case demonstrates how the Slack API can be utilized to perform a company-wide survey by creating a dedicated channel to receive and track feedback replies.
Clients
slack: Client
Isolated
One way to interact with the Slack platform is its HTTP RPC-based Web API, a collection of methods requiring OAuth 2.0-based user, bot, or workspace tokens blessed with related OAuth scopes.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://slack.com/api" - URL of the target service
post admin.apps.approve
Isolated FunctionResource Function
function post admin\.apps\.approve(AdminAppsApproveBody payload, map<string|string[]> headers) returns DefaultSuccessResponse|errorApprove an app for installation on a workspace.
Parameters
- payload AdminAppsApproveBody -
Return Type
- DefaultSuccessResponse|error - Typical success response
get admin.apps.approved.list
Isolated FunctionResource Function
function get admin\.apps\.approved\.list(map<string|string[]> headers, *AdminAppsApprovedListQueries queries) returns DefaultSuccessResponse1|errorList approved apps for an org or workspace.
Parameters
- queries *AdminAppsApprovedListQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse1|error - Typical success response
get admin.apps.requests.list
Isolated FunctionResource Function
function get admin\.apps\.requests\.list(map<string|string[]> headers, *AdminAppsRequestsListQueries queries) returns DefaultSuccessResponse2|errorList app requests for a team/workspace.
Parameters
- queries *AdminAppsRequestsListQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse2|error - Typical success response
post admin.apps.restrict
Isolated FunctionResource Function
function post admin\.apps\.restrict(AdminAppsRestrictBody payload, map<string|string[]> headers) returns DefaultSuccessResponse3|errorRestrict an app for installation on a workspace.
Parameters
- payload AdminAppsRestrictBody -
Return Type
- DefaultSuccessResponse3|error - Typical success response
get admin.apps.restricted.list
Isolated FunctionResource Function
function get admin\.apps\.restricted\.list(map<string|string[]> headers, *AdminAppsRestrictedListQueries queries) returns DefaultSuccessResponse4|errorList restricted apps for an org or workspace.
Parameters
- queries *AdminAppsRestrictedListQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse4|error - Typical success response
post admin.conversations.archive
Isolated FunctionResource Function
function post admin\.conversations\.archive(AdminConversationsArchiveBody payload, map<string|string[]> headers) returns AdminConversationsArchiveResponse|errorArchive a public or private channel.
Parameters
- payload AdminConversationsArchiveBody -
Return Type
- AdminConversationsArchiveResponse|error - Typical success response
post admin.conversations.convertToPrivate
Isolated FunctionResource Function
function post admin\.conversations\.convertToPrivate(AdminConversationsConvertToPrivateBody payload, map<string|string[]> headers) returns AdminConversationsConvertToPrivateResponse|errorConvert a public channel to a private channel.
Parameters
- payload AdminConversationsConvertToPrivateBody -
Return Type
- AdminConversationsConvertToPrivateResponse|error - Typical success response
post admin.conversations.create
Isolated FunctionResource Function
function post admin\.conversations\.create(AdminConversationsCreateBody payload, map<string|string[]> headers) returns AdminConversationsCreateResponse|errorCreate a public or private channel-based conversation.
Parameters
- payload AdminConversationsCreateBody -
Return Type
- AdminConversationsCreateResponse|error - Typical success response
post admin.conversations.delete
Isolated FunctionResource Function
function post admin\.conversations\.delete(AdminConversationsDeleteBody payload, map<string|string[]> headers) returns AdminConversationsDeleteResponse|errorDelete a public or private channel.
Parameters
- payload AdminConversationsDeleteBody -
Return Type
- AdminConversationsDeleteResponse|error - Typical success response
post admin.conversations.disconnectShared
Isolated FunctionResource Function
function post admin\.conversations\.disconnectShared(AdminConversationsDisconnectSharedBody payload, map<string|string[]> headers) returns AdminConversationsRenameResponse|errorDisconnect a connected channel from one or more workspaces.
Parameters
- payload AdminConversationsDisconnectSharedBody -
Return Type
- AdminConversationsRenameResponse|error - Typical success response
get admin.conversations.ekm.listOriginalConnectedChannelInfo
Isolated FunctionResource Function
function get admin\.conversations\.ekm\.listOriginalConnectedChannelInfo(map<string|string[]> headers, *AdminConversationsEkmListOriginalConnectedChannelInfoQueries queries) returns DefaultSuccessResponse5|errorList 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.
Parameters
- queries *AdminConversationsEkmListOriginalConnectedChannelInfoQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse5|error - Typical success response
get admin.conversations.getConversationPrefs
Isolated FunctionResource Function
function get admin\.conversations\.getConversationPrefs(map<string|string[]> headers, *AdminConversationsGetConversationPrefsQueries queries) returns AdminConversationsGetConversationPrefsResponse|errorGet conversation preferences for a public or private channel.
Parameters
- queries *AdminConversationsGetConversationPrefsQueries - Queries to be sent with the request
Return Type
- AdminConversationsGetConversationPrefsResponse|error - Typical success response
get admin.conversations.getTeams
Isolated FunctionResource Function
function get admin\.conversations\.getTeams(map<string|string[]> headers, *AdminConversationsGetTeamsQueries queries) returns AdminConversationsGetTeamsResponse|errorGet all the workspaces a given public or private channel is connected to within this Enterprise org.
Parameters
- queries *AdminConversationsGetTeamsQueries - Queries to be sent with the request
Return Type
- AdminConversationsGetTeamsResponse|error - Typical success response
post admin.conversations.invite
Isolated FunctionResource Function
function post admin\.conversations\.invite(AdminConversationsInviteBody payload, map<string|string[]> headers) returns AdminConversationsInviteResponse|errorInvite a user to a public or private channel.
Parameters
- payload AdminConversationsInviteBody -
Return Type
- AdminConversationsInviteResponse|error - Typical success response
post admin.conversations.rename
Isolated FunctionResource Function
function post admin\.conversations\.rename(AdminConversationsRenameBody payload, map<string|string[]> headers) returns AdminConversationsRenameResponse1|errorRename a public or private channel.
Parameters
- payload AdminConversationsRenameBody -
Return Type
- AdminConversationsRenameResponse1|error - Typical success response
post admin.conversations.restrictAccess.addGroup
Isolated FunctionResource Function
function post admin\.conversations\.restrictAccess\.addGroup(AdminConversationsRestrictAccessAddGroupBody payload, map<string|string[]> headers) returns DefaultSuccessResponse6|errorAdd an allowlist of IDP groups for accessing a channel
Parameters
Return Type
- DefaultSuccessResponse6|error - Typical success response
get admin.conversations.restrictAccess.listGroups
Isolated FunctionResource Function
function get admin\.conversations\.restrictAccess\.listGroups(map<string|string[]> headers, *AdminConversationsRestrictAccessListGroupsQueries queries) returns DefaultSuccessResponse7|errorList all IDP Groups linked to a channel
Parameters
- queries *AdminConversationsRestrictAccessListGroupsQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse7|error - Typical success response
post admin.conversations.restrictAccess.removeGroup
Isolated FunctionResource Function
function post admin\.conversations\.restrictAccess\.removeGroup(AdminConversationsRestrictAccessRemoveGroupBody payload, map<string|string[]> headers) returns DefaultSuccessResponse8|errorRemove a linked IDP group linked from a private channel
Parameters
Return Type
- DefaultSuccessResponse8|error - Typical success response
get admin.conversations.search
Isolated FunctionResource Function
function get admin\.conversations\.search(map<string|string[]> headers, *AdminConversationsSearchQueries queries) returns AdminConversationsSearchResponse|errorSearch for public or private channels in an Enterprise organization.
Parameters
- queries *AdminConversationsSearchQueries - Queries to be sent with the request
Return Type
- AdminConversationsSearchResponse|error - Typical success response
post admin.conversations.setConversationPrefs
Isolated FunctionResource Function
function post admin\.conversations\.setConversationPrefs(AdminConversationsSetConversationPrefsBody payload, map<string|string[]> headers) returns AdminConversationsSetConversationPrefsResponse|errorSet the posting permissions for a public or private channel.
Parameters
Return Type
- AdminConversationsSetConversationPrefsResponse|error - Typical success response
post admin.conversations.setTeams
Isolated FunctionResource Function
function post admin\.conversations\.setTeams(AdminConversationsSetTeamsBody payload, map<string|string[]> headers) returns DefaultSuccessResponse9|errorSet the workspaces in an Enterprise grid org that connect to a public or private channel.
Parameters
- payload AdminConversationsSetTeamsBody -
Return Type
- DefaultSuccessResponse9|error - Typical success response
post admin.conversations.unarchive
Isolated FunctionResource Function
function post admin\.conversations\.unarchive(AdminConversationsUnarchiveBody payload, map<string|string[]> headers) returns AdminConversationsUnarchiveResponse|errorUnarchive a public or private channel.
Parameters
- payload AdminConversationsUnarchiveBody -
Return Type
- AdminConversationsUnarchiveResponse|error - Typical success response
post admin.emoji.add
Isolated FunctionResource Function
function post admin\.emoji\.add(AdminEmojiAddBody payload, map<string|string[]> headers) returns DefaultSuccessResponse10|errorAdd an emoji.
Parameters
- payload AdminEmojiAddBody -
Return Type
- DefaultSuccessResponse10|error - Typical success response
post admin.emoji.addAlias
Isolated FunctionResource Function
function post admin\.emoji\.addAlias(AdminEmojiAddAliasBody payload, map<string|string[]> headers) returns DefaultSuccessResponse11|errorAdd an emoji alias.
Parameters
- payload AdminEmojiAddAliasBody -
Return Type
- DefaultSuccessResponse11|error - Typical success response
get admin.emoji.list
Isolated FunctionResource Function
function get admin\.emoji\.list(map<string|string[]> headers, *AdminEmojiListQueries queries) returns DefaultSuccessResponse12|errorList emoji for an Enterprise Grid organization.
Parameters
- queries *AdminEmojiListQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse12|error - Typical success response
post admin.emoji.remove
Isolated FunctionResource Function
function post admin\.emoji\.remove(AdminEmojiRemoveBody payload, map<string|string[]> headers) returns DefaultSuccessResponse13|errorRemove an emoji across an Enterprise Grid organization
Parameters
- payload AdminEmojiRemoveBody -
Return Type
- DefaultSuccessResponse13|error - Typical success response
post admin.emoji.rename
Isolated FunctionResource Function
function post admin\.emoji\.rename(AdminEmojiRenameBody payload, map<string|string[]> headers) returns DefaultSuccessResponse14|errorRename an emoji.
Parameters
- payload AdminEmojiRenameBody -
Return Type
- DefaultSuccessResponse14|error - Typical success response
post admin.inviteRequests.approve
Isolated FunctionResource Function
function post admin\.inviteRequests\.approve(record { invite_request_id string, team_id string } payload, map<string|string[]> headers) returns DefaultSuccessResponse15|errorApprove a workspace invite request.
Parameters
Return Type
- DefaultSuccessResponse15|error - Typical success response
get admin.inviteRequests.approved.list
Isolated FunctionResource Function
function get admin\.inviteRequests\.approved\.list(map<string|string[]> headers, *AdminInviteRequestsApprovedListQueries queries) returns DefaultSuccessResponse16|errorList all approved workspace invite requests.
Parameters
- queries *AdminInviteRequestsApprovedListQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse16|error - Typical success response
get admin.inviteRequests.denied.list
Isolated FunctionResource Function
function get admin\.inviteRequests\.denied\.list(map<string|string[]> headers, *AdminInviteRequestsDeniedListQueries queries) returns DefaultSuccessResponse17|errorList all denied workspace invite requests.
Parameters
- queries *AdminInviteRequestsDeniedListQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse17|error - Typical success response
post admin.inviteRequests.deny
Isolated FunctionResource Function
function post admin\.inviteRequests\.deny(record { invite_request_id string, team_id string } payload, map<string|string[]> headers) returns DefaultSuccessResponse18|errorDeny a workspace invite request.
Parameters
Return Type
- DefaultSuccessResponse18|error - Typical success response
get admin.inviteRequests.list
Isolated FunctionResource Function
function get admin\.inviteRequests\.list(map<string|string[]> headers, *AdminInviteRequestsListQueries queries) returns DefaultSuccessResponse19|errorList all pending workspace invite requests.
Parameters
- queries *AdminInviteRequestsListQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse19|error - Typical success response
get admin.teams.admins.list
Isolated FunctionResource Function
function get admin\.teams\.admins\.list(map<string|string[]> headers, *AdminTeamsAdminsListQueries queries) returns DefaultSuccessResponse20|errorList all of the admins on a given workspace.
Parameters
- queries *AdminTeamsAdminsListQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse20|error - Typical success response
post admin.teams.create
Isolated FunctionResource Function
function post admin\.teams\.create(AdminTeamsCreateBody payload, map<string|string[]> headers) returns DefaultSuccessResponse21|errorCreate an Enterprise team.
Parameters
- payload AdminTeamsCreateBody -
Return Type
- DefaultSuccessResponse21|error - Typical success response
get admin.teams.list
Isolated FunctionResource Function
function get admin\.teams\.list(map<string|string[]> headers, *AdminTeamsListQueries queries) returns DefaultSuccessResponse22|errorList all teams on an Enterprise organization
Parameters
- queries *AdminTeamsListQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse22|error - Typical success response
get admin.teams.owners.list
Isolated FunctionResource Function
function get admin\.teams\.owners\.list(map<string|string[]> headers, *AdminTeamsOwnersListQueries queries) returns DefaultSuccessResponse23|errorList all of the owners on a given workspace.
Parameters
- queries *AdminTeamsOwnersListQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse23|error - Typical success response
get admin.teams.settings.info
Isolated FunctionResource Function
function get admin\.teams\.settings\.info(map<string|string[]> headers, *AdminTeamsSettingsInfoQueries queries) returns DefaultSuccessResponse24|errorFetch information about settings in a workspace
Parameters
- queries *AdminTeamsSettingsInfoQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse24|error - Typical success response
post admin.teams.settings.setDefaultChannels
Isolated FunctionResource Function
function post admin\.teams\.settings\.setDefaultChannels(AdminTeamsSettingsSetDefaultChannelsBody payload, map<string|string[]> headers) returns DefaultSuccessResponse25|errorSet the default channels of a workspace.
Parameters
- payload AdminTeamsSettingsSetDefaultChannelsBody -
Return Type
- DefaultSuccessResponse25|error - Typical success response
post admin.teams.settings.setDescription
Isolated FunctionResource Function
function post admin\.teams\.settings\.setDescription(AdminTeamsSettingsSetDescriptionBody payload, map<string|string[]> headers) returns DefaultSuccessResponse26|errorSet the description of a given workspace.
Parameters
- payload AdminTeamsSettingsSetDescriptionBody -
Return Type
- DefaultSuccessResponse26|error - Typical success response
post admin.teams.settings.setDiscoverability
Isolated FunctionResource Function
function post admin\.teams\.settings\.setDiscoverability(AdminTeamsSettingsSetDiscoverabilityBody payload, map<string|string[]> headers) returns DefaultSuccessResponse27|errorAn API method that allows admins to set the discoverability of a given workspace
Parameters
- payload AdminTeamsSettingsSetDiscoverabilityBody -
Return Type
- DefaultSuccessResponse27|error - Typical success response
post admin.teams.settings.setIcon
Isolated FunctionResource Function
function post admin\.teams\.settings\.setIcon(AdminTeamsSettingsSetIconBody payload, map<string|string[]> headers) returns DefaultSuccessResponse28|errorSets the icon of a workspace.
Parameters
- payload AdminTeamsSettingsSetIconBody -
Return Type
- DefaultSuccessResponse28|error - Typical success response
post admin.teams.settings.setName
Isolated FunctionResource Function
function post admin\.teams\.settings\.setName(AdminTeamsSettingsSetNameBody payload, map<string|string[]> headers) returns DefaultSuccessResponse29|errorSet the name of a given workspace.
Parameters
- payload AdminTeamsSettingsSetNameBody -
Return Type
- DefaultSuccessResponse29|error - Typical success response
post admin.usergroups.addChannels
Isolated FunctionResource Function
function post admin\.usergroups\.addChannels(AdminUsergroupsAddChannelsBody payload, map<string|string[]> headers) returns DefaultSuccessResponse30|errorAdd one or more default channels to an IDP group.
Parameters
- payload AdminUsergroupsAddChannelsBody -
Return Type
- DefaultSuccessResponse30|error - Typical success response
post admin.usergroups.addTeams
Isolated FunctionResource Function
function post admin\.usergroups\.addTeams(AdminUsergroupsAddTeamsBody payload, map<string|string[]> headers) returns DefaultSuccessResponse31|errorAssociate one or more default workspaces with an organization-wide IDP group.
Parameters
- payload AdminUsergroupsAddTeamsBody -
Return Type
- DefaultSuccessResponse31|error - Typical success response
get admin.usergroups.listChannels
Isolated FunctionResource Function
function get admin\.usergroups\.listChannels(map<string|string[]> headers, *AdminUsergroupsListChannelsQueries queries) returns DefaultSuccessResponse32|errorList the channels linked to an org-level IDP group (user group).
Parameters
- queries *AdminUsergroupsListChannelsQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse32|error - Typical success response
post admin.usergroups.removeChannels
Isolated FunctionResource Function
function post admin\.usergroups\.removeChannels(AdminUsergroupsRemoveChannelsBody payload, map<string|string[]> headers) returns DefaultSuccessResponse33|errorRemove one or more default channels from an org-level IDP group (user group).
Parameters
- payload AdminUsergroupsRemoveChannelsBody -
Return Type
- DefaultSuccessResponse33|error - Typical success response
post admin.users.assign
Isolated FunctionResource Function
function post admin\.users\.assign(AdminUsersAssignBody payload, map<string|string[]> headers) returns DefaultSuccessResponse34|errorAdd an Enterprise user to a workspace.
Parameters
- payload AdminUsersAssignBody -
Return Type
- DefaultSuccessResponse34|error - Typical success response
post admin.users.invite
Isolated FunctionResource Function
function post admin\.users\.invite(AdminUsersInviteBody payload, map<string|string[]> headers) returns DefaultSuccessResponse35|errorInvite a user to a workspace.
Parameters
- payload AdminUsersInviteBody -
Return Type
- DefaultSuccessResponse35|error - Typical success response
get admin.users.list
Isolated FunctionResource Function
function get admin\.users\.list(map<string|string[]> headers, *AdminUsersListQueries queries) returns DefaultSuccessResponse36|errorList users on a workspace
Parameters
- queries *AdminUsersListQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse36|error - Typical success response
post admin.users.remove
Isolated FunctionResource Function
function post admin\.users\.remove(AdminUsersRemoveBody payload, map<string|string[]> headers) returns DefaultSuccessResponse37|errorRemove a user from a workspace.
Parameters
- payload AdminUsersRemoveBody -
Return Type
- DefaultSuccessResponse37|error - Typical success response
post admin.users.session.invalidate
Isolated FunctionResource Function
function post admin\.users\.session\.invalidate(AdminUsersSessionInvalidateBody payload, map<string|string[]> headers) returns DefaultSuccessResponse38|errorInvalidate a single session for a user by session_id
Parameters
- payload AdminUsersSessionInvalidateBody -
Return Type
- DefaultSuccessResponse38|error - Typical success response
post admin.users.session.reset
Isolated FunctionResource Function
function post admin\.users\.session\.reset(AdminUsersSessionResetBody payload, map<string|string[]> headers) returns DefaultSuccessResponse39|errorWipes all valid sessions on all devices for a given user
Parameters
- payload AdminUsersSessionResetBody -
Return Type
- DefaultSuccessResponse39|error - Typical success response
post admin.users.setAdmin
Isolated FunctionResource Function
function post admin\.users\.setAdmin(AdminUsersSetAdminBody payload, map<string|string[]> headers) returns DefaultSuccessResponse40|errorSet an existing guest, regular user, or owner to be an admin user.
Parameters
- payload AdminUsersSetAdminBody -
Return Type
- DefaultSuccessResponse40|error - Typical success response
post admin.users.setExpiration
Isolated FunctionResource Function
function post admin\.users\.setExpiration(AdminUsersSetExpirationBody payload, map<string|string[]> headers) returns DefaultSuccessResponse41|errorSet an expiration for a guest user
Parameters
- payload AdminUsersSetExpirationBody -
Return Type
- DefaultSuccessResponse41|error - Typical success response
post admin.users.setOwner
Isolated FunctionResource Function
function post admin\.users\.setOwner(AdminUsersSetOwnerHeaders headers, AdminUsersSetOwnerBody payload) returns DefaultSuccessResponse42|errorSet an existing guest, regular user, or admin user to be a workspace owner.
Parameters
- headers AdminUsersSetOwnerHeaders - Headers to be sent with the request
- payload AdminUsersSetOwnerBody -
Return Type
- DefaultSuccessResponse42|error - Typical success response
post admin.users.setRegular
Isolated FunctionResource Function
function post admin\.users\.setRegular(AdminUsersSetRegularBody payload, map<string|string[]> headers) returns DefaultSuccessResponse43|errorSet an existing guest user, admin user, or owner to be a regular user.
Parameters
- payload AdminUsersSetRegularBody -
Return Type
- DefaultSuccessResponse43|error - Typical success response
get api.test
Isolated FunctionResource Function
function get api\.test(map<string|string[]> headers, *ApiTestQueries queries) returns ApiTestResponse|errorChecks API calling code.
Parameters
- queries *ApiTestQueries - Queries to be sent with the request
Return Type
- ApiTestResponse|error - Standard success response
get apps.event.authorizations.list
Isolated FunctionResource Function
function get apps\.event\.authorizations\.list(map<string|string[]> headers, *AppsEventAuthorizationsListQueries queries) returns DefaultSuccessResponse44|errorGet a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.
Parameters
- queries *AppsEventAuthorizationsListQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse44|error - Typical success response
get apps.permissions.info
Isolated FunctionResource Function
function get apps\.permissions\.info(map<string|string[]> headers) returns AppsPermissionsInfoResponse|errorReturns list of permissions this app has on a team.
Return Type
- AppsPermissionsInfoResponse|error - Standard success response when used with a user token
get apps.permissions.request
Isolated FunctionResource Function
function get apps\.permissions\.request(map<string|string[]> headers, *AppsPermissionsRequestQueries queries) returns AppsPermissionsRequestResponse|errorAllows an app to request additional scopes
Parameters
- queries *AppsPermissionsRequestQueries - Queries to be sent with the request
Return Type
- AppsPermissionsRequestResponse|error - Standard success response when used with a user token
get apps.permissions.resources.list
Isolated FunctionResource Function
function get apps\.permissions\.resources\.list(map<string|string[]> headers, *AppsPermissionsResourcesListQueries queries) returns AppsPermissionsResourcesListResponse|errorReturns list of resource grants this app has on a team.
Parameters
- queries *AppsPermissionsResourcesListQueries - Queries to be sent with the request
Return Type
- AppsPermissionsResourcesListResponse|error - Typical successful paginated response
get apps.permissions.scopes.list
Isolated FunctionResource Function
function get apps\.permissions\.scopes\.list(map<string|string[]> headers) returns ApiPermissionsScopesListResponse|errorReturns list of scopes this app has on a team.
Return Type
- ApiPermissionsScopesListResponse|error - Typical successful paginated response
get apps.permissions.users.list
Isolated FunctionResource Function
function get apps\.permissions\.users\.list(map<string|string[]> headers, *AppsPermissionsUsersListQueries queries) returns DefaultSuccessResponse45|errorReturns list of user grants and corresponding scopes this app has on a team.
Parameters
- queries *AppsPermissionsUsersListQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse45|error - Typical successful paginated response
get apps.permissions.users.request
Isolated FunctionResource Function
function get apps\.permissions\.users\.request(map<string|string[]> headers, *AppsPermissionsUsersRequestQueries queries) returns DefaultSuccessResponse46|errorEnables an app to trigger a permissions modal to grant an app access to a user access scope.
Parameters
- queries *AppsPermissionsUsersRequestQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse46|error - Standard success response when used with a user token
get apps.uninstall
Isolated FunctionResource Function
function get apps\.uninstall(map<string|string[]> headers, *AppsUninstallQueries queries) returns AppsUninstallResponse|errorUninstalls your app from a workspace.
Parameters
- queries *AppsUninstallQueries - Queries to be sent with the request
Return Type
- AppsUninstallResponse|error - Typical success response
get auth.revoke
Isolated FunctionResource Function
function get auth\.revoke(map<string|string[]> headers, *AuthRevokeQueries queries) returns AuthRevokeResponse|errorRevokes a token.
Parameters
- queries *AuthRevokeQueries - Queries to be sent with the request
Return Type
- AuthRevokeResponse|error - Typical success response
get auth.test
Isolated FunctionResource Function
function get auth\.test(map<string|string[]> headers) returns AuthTestResponse|errorChecks authentication & identity.
Return Type
- AuthTestResponse|error - Standard success response when used with a user token
get bots.info
Isolated FunctionResource Function
function get bots\.info(map<string|string[]> headers, *BotsInfoQueries queries) returns BotsInfoResponse|errorGets information about a bot user.
Parameters
- queries *BotsInfoQueries - Queries to be sent with the request
Return Type
- BotsInfoResponse|error - When successful, returns bot info by bot ID
post calls.add
Isolated FunctionResource Function
function post calls\.add(CallsAddBody payload, map<string|string[]> headers) returns DefaultSuccessResponse47|errorRegisters a new Call.
Parameters
- payload CallsAddBody -
Return Type
- DefaultSuccessResponse47|error - Typical success response
post calls.end
Isolated FunctionResource Function
function post calls\.end(CallsEndBody payload, map<string|string[]> headers) returns DefaultSuccessResponse48|errorEnds a Call.
Parameters
- payload CallsEndBody -
Return Type
- DefaultSuccessResponse48|error - Typical success response
get calls.info
Isolated FunctionResource Function
function get calls\.info(map<string|string[]> headers, *CallsInfoQueries queries) returns DefaultSuccessResponse49|errorReturns information about a Call.
Parameters
- queries *CallsInfoQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse49|error - Typical success response
post calls.participants.add
Isolated FunctionResource Function
function post calls\.participants\.add(CallsParticipantsAddBody payload, map<string|string[]> headers) returns DefaultSuccessResponse50|errorRegisters new participants added to a Call.
Parameters
- payload CallsParticipantsAddBody -
Return Type
- DefaultSuccessResponse50|error - Typical success response
post calls.participants.remove
Isolated FunctionResource Function
function post calls\.participants\.remove(CallsParticipantsRemoveBody payload, map<string|string[]> headers) returns DefaultSuccessResponse51|errorRegisters participants removed from a Call.
Parameters
- payload CallsParticipantsRemoveBody -
Return Type
- DefaultSuccessResponse51|error - Typical success response
post calls.update
Isolated FunctionResource Function
function post calls\.update(CallsUpdateBody payload, map<string|string[]> headers) returns DefaultSuccessResponse52|errorUpdates information about a Call.
Parameters
- payload CallsUpdateBody -
Return Type
- DefaultSuccessResponse52|error - Typical success response
post chat.delete
Isolated FunctionResource Function
function post chat\.delete(ChatDeleteBody payload, map<string|string[]> headers) returns ChatDeleteResponse|errorDeletes a message.
Parameters
- payload ChatDeleteBody -
Return Type
- ChatDeleteResponse|error - Typical success response
post chat.deleteScheduledMessage
Isolated FunctionResource Function
function post chat\.deleteScheduledMessage(ChatDeleteScheduledMessageBody payload, map<string|string[]> headers) returns ChatDeleteScheduledMessageResponse|errorDeletes a pending scheduled message from the queue.
Parameters
- payload ChatDeleteScheduledMessageBody -
Return Type
- ChatDeleteScheduledMessageResponse|error - Typical success response
get chat.getPermalink
Isolated FunctionResource Function
function get chat\.getPermalink(map<string|string[]> headers, *ChatGetPermalinkQueries queries) returns ChatGetPermalinkResponse|errorRetrieve a permalink URL for a specific extant message
Parameters
- queries *ChatGetPermalinkQueries - Queries to be sent with the request
Return Type
- ChatGetPermalinkResponse|error - Standard success response
post chat.meMessage
Isolated FunctionResource Function
function post chat\.meMessage(ChatMeMessageBody payload, map<string|string[]> headers) returns ChatMeMessageResponse|errorShare a me message into a channel.
Parameters
- payload ChatMeMessageBody -
Return Type
- ChatMeMessageResponse|error - Typical success response
post chat.postEphemeral
Isolated FunctionResource Function
function post chat\.postEphemeral(ChatPostEphemeralBody payload, map<string|string[]> headers) returns ChatPostEphemeralResponse|errorSends an ephemeral message to a user in a channel.
Parameters
- payload ChatPostEphemeralBody -
Return Type
- ChatPostEphemeralResponse|error - Typical success response
post chat.postMessage
Isolated FunctionResource Function
function post chat\.postMessage(ChatPostMessageBody payload, map<string|string[]> headers) returns ChatPostMessageResponse|errorSends a message to a channel.
Parameters
- payload ChatPostMessageBody -
Return Type
- ChatPostMessageResponse|error - Typical success response
post chat.scheduleMessage
Isolated FunctionResource Function
function post chat\.scheduleMessage(ChatScheduleMessageBody payload, map<string|string[]> headers) returns ChatScheduleMessageResponse|errorSchedules a message to be sent to a channel.
Parameters
- payload ChatScheduleMessageBody -
Return Type
- ChatScheduleMessageResponse|error - Typical success response
get chat.scheduledMessages.list
Isolated FunctionResource Function
function get chat\.scheduledMessages\.list(map<string|string[]> headers, *ChatScheduledMessagesListQueries queries) returns ChatScheduledMessagesListResponse|errorReturns a list of scheduled messages.
Parameters
- queries *ChatScheduledMessagesListQueries - Queries to be sent with the request
Return Type
- ChatScheduledMessagesListResponse|error - Typical success response
post chat.unfurl
Isolated FunctionResource Function
function post chat\.unfurl(ChatUnfurlBody payload, map<string|string[]> headers) returns ChatUnfurlResponse|errorProvide custom unfurl behavior for user-posted URLs
Parameters
- payload ChatUnfurlBody -
Return Type
- ChatUnfurlResponse|error - Typical, minimal success response
post chat.update
Isolated FunctionResource Function
function post chat\.update(ChatUpdateBody payload, map<string|string[]> headers) returns ChatUpdateResponse|errorUpdates a message.
Parameters
- payload ChatUpdateBody -
Return Type
- ChatUpdateResponse|error - Typical success response
post conversations.archive
Isolated FunctionResource Function
function post conversations\.archive(ConversationsArchiveBody payload, map<string|string[]> headers) returns ConversationsArchiveResponse|errorArchives a conversation.
Parameters
- payload ConversationsArchiveBody -
Return Type
- ConversationsArchiveResponse|error - Typical success response
post conversations.close
Isolated FunctionResource Function
function post conversations\.close(ConversationsCloseBody payload, map<string|string[]> headers) returns ConversationsCloseResponse|errorCloses a direct message or multi-person direct message.
Parameters
- payload ConversationsCloseBody -
Return Type
- ConversationsCloseResponse|error - Typical success response
post conversations.create
Isolated FunctionResource Function
function post conversations\.create(ConversationsCreateBody payload, map<string|string[]> headers) returns ConversationsCreateResponse|errorInitiates a public or private channel-based conversation
Parameters
- payload ConversationsCreateBody -
Return Type
- ConversationsCreateResponse|error - If successful, the command returns a rather stark conversation object
get conversations.history
Isolated FunctionResource Function
function get conversations\.history(map<string|string[]> headers, *ConversationsHistoryQueries queries) returns ConversationsHistoryResponse|errorFetches a conversation's history of messages and events.
Parameters
- queries *ConversationsHistoryQueries - Queries to be sent with the request
Return Type
- ConversationsHistoryResponse|error - Typical success response containing a channel's messages
get conversations.info
Isolated FunctionResource Function
function get conversations\.info(map<string|string[]> headers, *ConversationsInfoQueries queries) returns ConversationsInfoResponse|errorRetrieve information about a conversation.
Parameters
- queries *ConversationsInfoQueries - Queries to be sent with the request
Return Type
- ConversationsInfoResponse|error - Typical success response for a public channel. (Also, a response from a private channel and a multi-party IM is very similar to this example.)
post conversations.invite
Isolated FunctionResource Function
function post conversations\.invite(ConversationsInviteBody payload, map<string|string[]> headers) returns ConversationsInviteErrorResponse|errorInvites users to a channel.
Parameters
- payload ConversationsInviteBody -
Return Type
- ConversationsInviteErrorResponse|error - Typical success response when an invitation is extended
post conversations.join
Isolated FunctionResource Function
function post conversations\.join(ConversationsJoinBody payload, map<string|string[]> headers) returns ConversationsJoinResponse|errorJoins an existing conversation.
Parameters
- payload ConversationsJoinBody -
Return Type
- ConversationsJoinResponse|error - Typical success response
post conversations.kick
Isolated FunctionResource Function
function post conversations\.kick(ConversationsKickBody payload, map<string|string[]> headers) returns ConversationsKickResponse|errorRemoves a user from a conversation.
Parameters
- payload ConversationsKickBody -
Return Type
- ConversationsKickResponse|error - Typical success response
post conversations.leave
Isolated FunctionResource Function
function post conversations\.leave(ConversationsLeaveBody payload, map<string|string[]> headers) returns ConversationsLeaveResponse|errorLeaves a conversation.
Parameters
- payload ConversationsLeaveBody -
Return Type
- ConversationsLeaveResponse|error - Typical success response
get conversations.list
Isolated FunctionResource Function
function get conversations\.list(map<string|string[]> headers, *ConversationsListQueries queries) returns ConversationsListResponse|errorLists all channels in a Slack team.
Parameters
- queries *ConversationsListQueries - Queries to be sent with the request
Return Type
- ConversationsListResponse|error - Typical success response with only public channels
post conversations.mark
Isolated FunctionResource Function
function post conversations\.mark(ConversationsMarkBody payload, map<string|string[]> headers) returns ConversationsMarkResponse|errorSets the read cursor in a channel.
Parameters
- payload ConversationsMarkBody -
Return Type
- ConversationsMarkResponse|error - Typical success response
get conversations.members
Isolated FunctionResource Function
function get conversations\.members(map<string|string[]> headers, *ConversationsMembersQueries queries) returns ConversationsMembersResponse|errorRetrieve members of a conversation.
Parameters
- queries *ConversationsMembersQueries - Queries to be sent with the request
Return Type
- ConversationsMembersResponse|error - Typical paginated success response
post conversations.open
Isolated FunctionResource Function
function post conversations\.open(ConversationsOpenBody payload, map<string|string[]> headers) returns ConversationsOpenResponse|errorOpens or resumes a direct message or multi-person direct message.
Parameters
- payload ConversationsOpenBody -
Return Type
- ConversationsOpenResponse|error - Typical success response
post conversations.rename
Isolated FunctionResource Function
function post conversations\.rename(ConversationsRenameBody payload, map<string|string[]> headers) returns ConversationsRenameResponse|errorRenames a conversation.
Parameters
- payload ConversationsRenameBody -
Return Type
- ConversationsRenameResponse|error - Typical success response
get conversations.replies
Isolated FunctionResource Function
function get conversations\.replies(map<string|string[]> headers, *ConversationsRepliesQueries queries) returns ConversationsRepliesResponse|errorRetrieve a thread of messages posted to a conversation
Parameters
- queries *ConversationsRepliesQueries - Queries to be sent with the request
Return Type
- ConversationsRepliesResponse|error - Typical success response
post conversations.setPurpose
Isolated FunctionResource Function
function post conversations\.setPurpose(ConversationsSetPurposeBody payload, map<string|string[]> headers) returns ConversationsSetPurposeResponse|errorSets the purpose for a conversation.
Parameters
- payload ConversationsSetPurposeBody -
Return Type
- ConversationsSetPurposeResponse|error - Typical success response
post conversations.setTopic
Isolated FunctionResource Function
function post conversations\.setTopic(ConversationsSetTopicBody payload, map<string|string[]> headers) returns ConversationsSetTopicResponse|errorSets the topic for a conversation.
Parameters
- payload ConversationsSetTopicBody -
Return Type
- ConversationsSetTopicResponse|error - Typical success response
post conversations.unarchive
Isolated FunctionResource Function
function post conversations\.unarchive(ConversationsUnarchiveBody payload, map<string|string[]> headers) returns ConversationsUnarchiveResponse|errorReverses conversation archival.
Parameters
- payload ConversationsUnarchiveBody -
Return Type
- ConversationsUnarchiveResponse|error - Typical success response
get dialog.open
Isolated FunctionResource Function
function get dialog\.open(map<string|string[]> headers, *DialogOpenQueries queries) returns DialogOpenResponse|errorOpen a dialog with a user
Parameters
- queries *DialogOpenQueries - Queries to be sent with the request
Return Type
- DialogOpenResponse|error - Typical success response is quite minimal
post dnd.endDnd
Isolated FunctionResource Function
function post dnd\.endDnd(map<string|string[]> headers) returns DndEndDndResponse|errorEnds the current user's Do Not Disturb session immediately.
Return Type
- DndEndDndResponse|error - Typical success response
post dnd.endSnooze
Isolated FunctionResource Function
function post dnd\.endSnooze(map<string|string[]> headers) returns DndEndSnoozeResponse|errorEnds the current user's snooze mode immediately.
Return Type
- DndEndSnoozeResponse|error - Typical success response
get dnd.info
Isolated FunctionResource Function
function get dnd\.info(map<string|string[]> headers, *DndInfoQueries queries) returns DndInfoResponse|errorRetrieves a user's current Do Not Disturb status.
Parameters
- queries *DndInfoQueries - Queries to be sent with the request
Return Type
- DndInfoResponse|error - Typical success response
post dnd.setSnooze
Isolated FunctionResource Function
function post dnd\.setSnooze(DndSetSnoozeBody payload, map<string|string[]> headers) returns DndSetSnoozeResponse|errorTurns on Do Not Disturb mode for the current user, or changes its duration.
Parameters
- payload DndSetSnoozeBody -
Return Type
- DndSetSnoozeResponse|error - Typical success response
get dnd.teamInfo
Isolated FunctionResource Function
function get dnd\.teamInfo(map<string|string[]> headers, *DndTeamInfoQueries queries) returns DefaultSuccessResponse53|errorRetrieves the Do Not Disturb status for up to 50 users on a team.
Parameters
- queries *DndTeamInfoQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse53|error - Typical success response
get emoji.list
Isolated FunctionResource Function
function get emoji\.list(map<string|string[]> headers) returns DefaultSuccessResponse54|errorLists custom emoji for a team.
Return Type
- DefaultSuccessResponse54|error - Typical success response
post files.comments.delete
Isolated FunctionResource Function
function post files\.comments\.delete(FilesCommentsDeleteBody payload, map<string|string[]> headers) returns FilesCommentsDeleteResponse|errorDeletes an existing comment on a file.
Parameters
- payload FilesCommentsDeleteBody -
Return Type
- FilesCommentsDeleteResponse|error - Standard success response is very simple
post files.delete
Isolated FunctionResource Function
function post files\.delete(FilesDeleteBody payload, map<string|string[]> headers) returns FilesDeleteResponse|errorDeletes a file.
Parameters
- payload FilesDeleteBody -
Return Type
- FilesDeleteResponse|error - Typical success response
get files.info
Isolated FunctionResource Function
function get files\.info(map<string|string[]> headers, *FilesInfoQueries queries) returns FilesInfoResponse|errorGets information about a file.
Parameters
- queries *FilesInfoQueries - Queries to be sent with the request
Return Type
- FilesInfoResponse|error - Typical success response
get files.list
Isolated FunctionResource Function
function get files\.list(map<string|string[]> headers, *FilesListQueries queries) returns FilesListResponse|errorList for a team, in a channel, or from a user with applied filters.
Parameters
- queries *FilesListQueries - Queries to be sent with the request
Return Type
- FilesListResponse|error - Typical success response
post files.remote.add
Isolated FunctionResource Function
function post files\.remote\.add(FilesRemoteAddBody payload, map<string|string[]> headers) returns DefaultSuccessResponse55|errorAdds a file from a remote service
Parameters
- payload FilesRemoteAddBody -
Return Type
- DefaultSuccessResponse55|error - Typical success response
get files.remote.info
Isolated FunctionResource Function
function get files\.remote\.info(map<string|string[]> headers, *FilesRemoteInfoQueries queries) returns DefaultSuccessResponse56|errorRetrieve information about a remote file added to Slack
Parameters
- queries *FilesRemoteInfoQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse56|error - Typical success response
get files.remote.list
Isolated FunctionResource Function
function get files\.remote\.list(map<string|string[]> headers, *FilesRemoteListQueries queries) returns DefaultSuccessResponse57|errorRetrieve information about a remote file added to Slack
Parameters
- queries *FilesRemoteListQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse57|error - Typical success response
post files.remote.remove
Isolated FunctionResource Function
function post files\.remote\.remove(FilesRemoteRemoveBody payload, map<string|string[]> headers) returns DefaultSuccessResponse58|errorRemove a remote file.
Parameters
- payload FilesRemoteRemoveBody -
Return Type
- DefaultSuccessResponse58|error - Typical success response
get files.remote.share
Isolated FunctionResource Function
function get files\.remote\.share(map<string|string[]> headers, *FilesRemoteShareQueries queries) returns DefaultSuccessResponse59|errorShare a remote file into a channel.
Parameters
- queries *FilesRemoteShareQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse59|error - Typical success response
post files.remote.update
Isolated FunctionResource Function
function post files\.remote\.update(FilesRemoteUpdateBody payload, map<string|string[]> headers) returns DefaultSuccessResponse60|errorUpdates an existing remote file.
Parameters
- payload FilesRemoteUpdateBody -
Return Type
- DefaultSuccessResponse60|error - Typical success response
post files.revokePublicURL
Isolated FunctionResource Function
function post files\.revokePublicURL(FilesRevokePublicURLBody payload, map<string|string[]> headers) returns FilesRevokePublicURLResponse|errorRevokes public/external sharing access for a file
Parameters
- payload FilesRevokePublicURLBody -
Return Type
- FilesRevokePublicURLResponse|error - Typical success response
post files.sharedPublicURL
Isolated FunctionResource Function
function post files\.sharedPublicURL(FilesSharedPublicURLBody payload, map<string|string[]> headers) returns FilesSharedPublicURLResponse|errorEnables a file for public/external sharing.
Parameters
- payload FilesSharedPublicURLBody -
Return Type
- FilesSharedPublicURLResponse|error - Typical success response
post files.upload
Isolated FunctionResource Function
function post files\.upload(FilesUploadBody payload, map<string|string[]> headers) returns FilesUploadResponse|errorUploads or creates a file.
Parameters
- payload FilesUploadBody -
Return Type
- FilesUploadResponse|error - Success response after uploading a file to a channel with an initial message
get migration.exchange
Isolated FunctionResource Function
function get migration\.exchange(map<string|string[]> headers, *MigrationExchangeQueries queries) returns MigrationExchangeResponse|errorFor Enterprise Grid workspaces, map local user IDs to global user IDs
Parameters
- queries *MigrationExchangeQueries - Queries to be sent with the request
Return Type
- MigrationExchangeResponse|error - Typical success response when mappings exist for the specified user IDs
get oauth.access
Isolated FunctionResource Function
function get oauth\.access(map<string|string[]> headers, *OauthAccessQueries queries) returns DefaultSuccessResponse61|errorExchanges a temporary OAuth verifier code for an access token.
Parameters
- queries *OauthAccessQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse61|error - Successful user token negotiation for a single scope
get oauth.token
Isolated FunctionResource Function
function get oauth\.token(map<string|string[]> headers, *OauthTokenQueries queries) returns DefaultSuccessResponse62|errorExchanges a temporary OAuth verifier code for a workspace token.
Parameters
- queries *OauthTokenQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse62|error - Success example using a workspace app produces a very different kind of response
get oauth.v2.access
Isolated FunctionResource Function
function get oauth\.v2\.access(map<string|string[]> headers, *OauthV2AccessQueries queries) returns DefaultSuccessResponse63|errorExchanges a temporary OAuth verifier code for an access token.
Parameters
- queries *OauthV2AccessQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse63|error - Successful token request with scopes for both a bot user and a user token
post pins.add
Isolated FunctionResource Function
function post pins\.add(PinsAddBody payload, map<string|string[]> headers) returns PinsAddResponse|errorPins an item to a channel.
Parameters
- payload PinsAddBody -
Return Type
- PinsAddResponse|error - Typical success response
get pins.list
Isolated FunctionResource Function
function get pins\.list(map<string|string[]> headers, *PinsListQueries queries) returns InlineResponseItems200[]|errorLists items pinned to a channel.
Parameters
- queries *PinsListQueries - Queries to be sent with the request
Return Type
- InlineResponseItems200[]|error - Typical success response
post pins.remove
Isolated FunctionResource Function
function post pins\.remove(PinsRemoveBody payload, map<string|string[]> headers) returns PinsRemoveResponse|errorUn-pins an item from a channel.
Parameters
- payload PinsRemoveBody -
Return Type
- PinsRemoveResponse|error - Typical success response
post reactions.add
Isolated FunctionResource Function
function post reactions\.add(ReactionsAddBody payload, map<string|string[]> headers) returns ReactionsAddResponse|errorAdds a reaction to an item.
Parameters
- payload ReactionsAddBody -
Return Type
- ReactionsAddResponse|error - Typical success response
get reactions.get
Isolated FunctionResource Function
function get reactions\.get(map<string|string[]> headers, *ReactionsGetQueries queries) returns InlineResponseItems2001[]|errorGets reactions for an item.
Parameters
- queries *ReactionsGetQueries - Queries to be sent with the request
Return Type
- InlineResponseItems2001[]|error - Typical success response
get reactions.list
Isolated FunctionResource Function
function get reactions\.list(map<string|string[]> headers, *ReactionsListQueries queries) returns ReactionsListResponse|errorLists reactions made by a user.
Parameters
- queries *ReactionsListQueries - Queries to be sent with the request
Return Type
- ReactionsListResponse|error - Typical success response
post reactions.remove
Isolated FunctionResource Function
function post reactions\.remove(ReactionsRemoveBody payload, map<string|string[]> headers) returns ReactionsRemoveResponse|errorRemoves a reaction from an item.
Parameters
- payload ReactionsRemoveBody -
Return Type
- ReactionsRemoveResponse|error - Typical success response
post reminders.add
Isolated FunctionResource Function
function post reminders\.add(RemindersAddBody payload, map<string|string[]> headers) returns RemindersAddResponse|errorCreates a reminder.
Parameters
- payload RemindersAddBody -
Return Type
- RemindersAddResponse|error - Typical success response
post reminders.complete
Isolated FunctionResource Function
function post reminders\.complete(RemindersCompleteBody payload, map<string|string[]> headers) returns RemindersCompleteResponse|errorMarks a reminder as complete.
Parameters
- payload RemindersCompleteBody -
Return Type
- RemindersCompleteResponse|error - Typical success response
post reminders.delete
Isolated FunctionResource Function
function post reminders\.delete(RemindersDeleteBody payload, map<string|string[]> headers) returns RemindersDeleteResponse|errorDeletes a reminder.
Parameters
- payload RemindersDeleteBody -
Return Type
- RemindersDeleteResponse|error - Typical success response
get reminders.info
Isolated FunctionResource Function
function get reminders\.info(map<string|string[]> headers, *RemindersInfoQueries queries) returns RemindersInfoResponse|errorGets information about a reminder.
Parameters
- queries *RemindersInfoQueries - Queries to be sent with the request
Return Type
- RemindersInfoResponse|error - Typical success response
get reminders.list
Isolated FunctionResource Function
function get reminders\.list(map<string|string[]> headers) returns RemindersListResponse|errorLists all reminders created by or for a given user.
Return Type
- RemindersListResponse|error - Typical success response
get rtm.connect
Isolated FunctionResource Function
function get rtm\.connect(map<string|string[]> headers, *RtmConnectQueries queries) returns RtmConnectResponse|errorStarts a Real Time Messaging session.
Parameters
- queries *RtmConnectQueries - Queries to be sent with the request
Return Type
- RtmConnectResponse|error - Typical success response
get search.messages
Isolated FunctionResource Function
function get search\.messages(map<string|string[]> headers, *SearchMessagesQueries queries) returns DefaultSuccessResponse64|errorSearches for messages matching a query.
Parameters
- queries *SearchMessagesQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse64|error - Typical success response
post stars.add
Isolated FunctionResource Function
function post stars\.add(StarsAddBody payload, map<string|string[]> headers) returns StarsAddResponse|errorAdds a star to an item.
Parameters
- payload StarsAddBody -
Return Type
- StarsAddResponse|error - Typical success response
get stars.list
Isolated FunctionResource Function
function get stars\.list(map<string|string[]> headers, *StarsListQueries queries) returns StarsListResponse|errorLists stars for a user.
Parameters
- queries *StarsListQueries - Queries to be sent with the request
Return Type
- StarsListResponse|error - Typical success response
post stars.remove
Isolated FunctionResource Function
function post stars\.remove(StarsRemoveBody payload, map<string|string[]> headers) returns StarsRemoveResponse|errorRemoves a star from an item.
Parameters
- payload StarsRemoveBody -
Return Type
- StarsRemoveResponse|error - Typical success response
get team.accessLogs
Isolated FunctionResource Function
function get team\.accessLogs(map<string|string[]> headers, *TeamAccessLogsQueries queries) returns TeamAccessLogsResponse|errorGets the access logs for the current team.
Parameters
- queries *TeamAccessLogsQueries - Queries to be sent with the request
Return Type
- TeamAccessLogsResponse|error - This response demonstrates pagination and two access log entries
get team.billableInfo
Isolated FunctionResource Function
function get team\.billableInfo(map<string|string[]> headers, *TeamBillableInfoQueries queries) returns DefaultSuccessResponse65|errorGets billable users information for the current team.
Parameters
- queries *TeamBillableInfoQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse65|error - Typical success response
get team.info
Isolated FunctionResource Function
function get team\.info(map<string|string[]> headers, *TeamInfoQueries queries) returns TeamInfoResponse|errorGets information about the current team.
Parameters
- queries *TeamInfoQueries - Queries to be sent with the request
Return Type
- TeamInfoResponse|error - Typical success response
get team.integrationLogs
Isolated FunctionResource Function
function get team\.integrationLogs(map<string|string[]> headers, *TeamIntegrationLogsQueries queries) returns TeamIntegrationLogsResponse|errorGets the integration logs for the current team.
Parameters
- queries *TeamIntegrationLogsQueries - Queries to be sent with the request
Return Type
- TeamIntegrationLogsResponse|error - Typical success response
get team.profile.get
Isolated FunctionResource Function
function get team\.profile\.get(map<string|string[]> headers, *TeamProfileGetQueries queries) returns TeamProfileGetResponse|errorRetrieve a team's profile.
Parameters
- queries *TeamProfileGetQueries - Queries to be sent with the request
Return Type
- TeamProfileGetResponse|error - Typical success response
post usergroups.create
Isolated FunctionResource Function
function post usergroups\.create(UsergroupsCreateBody payload, map<string|string[]> headers) returns UsergroupsCreateResponse|errorCreate a User Group
Parameters
- payload UsergroupsCreateBody -
Return Type
- UsergroupsCreateResponse|error - Typical success response
post usergroups.disable
Isolated FunctionResource Function
function post usergroups\.disable(UsergroupsDisableBody payload, map<string|string[]> headers) returns UsergroupsDisableResponse|errorDisable an existing User Group
Parameters
- payload UsergroupsDisableBody -
Return Type
- UsergroupsDisableResponse|error - Typical success response
post usergroups.enable
Isolated FunctionResource Function
function post usergroups\.enable(UsergroupsEnableBody payload, map<string|string[]> headers) returns UsergroupsEnableResponse|errorEnable a User Group
Parameters
- payload UsergroupsEnableBody -
Return Type
- UsergroupsEnableResponse|error - Typical success response
get usergroups.list
Isolated FunctionResource Function
function get usergroups\.list(map<string|string[]> headers, *UsergroupsListQueries queries) returns UsergroupsListResponse|errorList all User Groups for a team
Parameters
- queries *UsergroupsListQueries - Queries to be sent with the request
Return Type
- UsergroupsListResponse|error - Typical success response
post usergroups.update
Isolated FunctionResource Function
function post usergroups\.update(UsergroupsUpdateBody payload, map<string|string[]> headers) returns UsergroupsUpdateResponse|errorUpdate an existing User Group
Parameters
- payload UsergroupsUpdateBody -
Return Type
- UsergroupsUpdateResponse|error - Typical success response
get usergroups.users.list
Isolated FunctionResource Function
function get usergroups\.users\.list(map<string|string[]> headers, *UsergroupsUsersListQueries queries) returns UsergroupsUsersListResponse|errorList all users in a User Group
Parameters
- queries *UsergroupsUsersListQueries - Queries to be sent with the request
Return Type
- UsergroupsUsersListResponse|error - Standard success response when used with a user token
post usergroups.users.update
Isolated FunctionResource Function
function post usergroups\.users\.update(UsergroupsUsersUpdateBody payload, map<string|string[]> headers) returns UsergroupsUsersUpdateResponse|errorUpdate the list of users for a User Group
Parameters
- payload UsergroupsUsersUpdateBody -
Return Type
- UsergroupsUsersUpdateResponse|error - Typical success response
get users.conversations
Isolated FunctionResource Function
function get users\.conversations(map<string|string[]> headers, *UsersConversationsQueries queries) returns UsersConversationsResponse|errorList conversations the calling user may access.
Parameters
- queries *UsersConversationsQueries - Queries to be sent with the request
Return Type
- UsersConversationsResponse|error - Typical success response with only public channels. Note how
num_membersandis_memberare not returned like typicalconversationsobjects
post users.deletePhoto
Isolated FunctionResource Function
function post users\.deletePhoto(UsersDeletePhotoBody payload, map<string|string[]> headers) returns UsersDeletePhotoResponse|errorDelete the user profile photo
Parameters
- payload UsersDeletePhotoBody -
Return Type
- UsersDeletePhotoResponse|error - Typical success response
get users.getPresence
Isolated FunctionResource Function
function get users\.getPresence(map<string|string[]> headers, *UsersGetPresenceQueries queries) returns APIMethodUsersGetPresence|errorGets user presence information.
Parameters
- queries *UsersGetPresenceQueries - Queries to be sent with the request
Return Type
- APIMethodUsersGetPresence|error - When requesting information for a different user, this method just returns the current presence (either
activeoraway)
get users.identity
Isolated FunctionResource Function
function get users\.identity(map<string|string[]> headers) returns InlineResponseItems2002[]|errorGet a user's identity.
Return Type
- InlineResponseItems2002[]|error - You will receive at a minimum the following information:
get users.info
Isolated FunctionResource Function
function get users\.info(map<string|string[]> headers, *UsersInfoQueries queries) returns UsersInfoResponse|errorGets information about a user.
Parameters
- queries *UsersInfoQueries - Queries to be sent with the request
Return Type
- UsersInfoResponse|error - Typical success response
get users.list
Isolated FunctionResource Function
function get users\.list(map<string|string[]> headers, *UsersListQueries queries) returns UsersListResponse|errorLists all users in a Slack team.
Parameters
- queries *UsersListQueries - Queries to be sent with the request
Return Type
- UsersListResponse|error - Typical success response
get users.lookupByEmail
Isolated FunctionResource Function
function get users\.lookupByEmail(map<string|string[]> headers, *UsersLookupByEmailQueries queries) returns UsersLookupByEmailResponse|errorFind a user with an email address.
Parameters
- queries *UsersLookupByEmailQueries - Queries to be sent with the request
Return Type
- UsersLookupByEmailResponse|error - Typical success response
get users.profile.get
Isolated FunctionResource Function
function get users\.profile\.get(map<string|string[]> headers, *UsersProfileGetQueries queries) returns UsersProfileGetResponse|errorRetrieves a user's profile information.
Parameters
- queries *UsersProfileGetQueries - Queries to be sent with the request
Return Type
- UsersProfileGetResponse|error - Typical success response
post users.profile.set
Isolated FunctionResource Function
function post users\.profile\.set(UsersProfileSetBody payload, map<string|string[]> headers) returns UsersProfileSetResponse|errorSet the profile information for a user.
Parameters
- payload UsersProfileSetBody -
Return Type
- UsersProfileSetResponse|error - Typical success response
post users.setActive
Isolated FunctionResource Function
function post users\.setActive(map<string|string[]> headers) returns UsersSetActiveResponse|errorMarked a user as active. Deprecated and non-functional.
Return Type
- UsersSetActiveResponse|error - Typical success response
post users.setPhoto
Isolated FunctionResource Function
function post users\.setPhoto(UsersSetPhotoBody payload, map<string|string[]> headers) returns UsersSetPhotoResponse|errorSet the user profile photo
Parameters
- payload UsersSetPhotoBody -
Return Type
- UsersSetPhotoResponse|error - Typical success response
post users.setPresence
Isolated FunctionResource Function
function post users\.setPresence(UsersSetPresenceBody payload, map<string|string[]> headers) returns UsersSetPresenceResponse|errorManually sets user presence.
Parameters
- payload UsersSetPresenceBody -
Return Type
- UsersSetPresenceResponse|error - Typical success response
get views.open
Isolated FunctionResource Function
function get views\.open(map<string|string[]> headers, *ViewsOpenQueries queries) returns DefaultSuccessResponse66|errorOpen a view for a user.
Parameters
- queries *ViewsOpenQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse66|error - Typical success response includes the opened view payload
get views.publish
Isolated FunctionResource Function
function get views\.publish(map<string|string[]> headers, *ViewsPublishQueries queries) returns DefaultSuccessResponse67|errorPublish a static view for a User.
Parameters
- queries *ViewsPublishQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse67|error - Typical success response includes the published view payload
get views.push
Isolated FunctionResource Function
function get views\.push(map<string|string[]> headers, *ViewsPushQueries queries) returns DefaultSuccessResponse68|errorPush a view onto the stack of a root view.
Parameters
- queries *ViewsPushQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse68|error - Typical success response includes the pushed view payload
get views.update
Isolated FunctionResource Function
function get views\.update(map<string|string[]> headers, *ViewsUpdateQueries queries) returns DefaultSuccessResponse69|errorUpdate an existing view.
Parameters
- queries *ViewsUpdateQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse69|error - Typical success response includes the updated view payload
get workflows.stepCompleted
Isolated FunctionResource Function
function get workflows\.stepCompleted(map<string|string[]> headers, *WorkflowsStepCompletedQueries queries) returns DefaultSuccessResponse70|errorIndicate that an app's step in a workflow completed execution.
Parameters
- queries *WorkflowsStepCompletedQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse70|error - Typical success response
get workflows.stepFailed
Isolated FunctionResource Function
function get workflows\.stepFailed(map<string|string[]> headers, *WorkflowsStepFailedQueries queries) returns DefaultSuccessResponse71|errorIndicate that an app's step in a workflow failed to execute.
Parameters
- queries *WorkflowsStepFailedQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse71|error - Typical success response
get workflows.updateStep
Isolated FunctionResource Function
function get workflows\.updateStep(map<string|string[]> headers, *WorkflowsUpdateStepQueries queries) returns DefaultSuccessResponse72|errorUpdate the configuration for a workflow extension step.
Parameters
- queries *WorkflowsUpdateStepQueries - Queries to be sent with the request
Return Type
- DefaultSuccessResponse72|error - Typical success response
Records
slack: '200200200200AnyOf12234
Closed record
Fields
- team '200Team3 -
- ok OkTrueDef -
- user '200User3 -
slack: '200200200AnyOf1123
Closed record
Fields
- file FileObj -
- comment CommentObj -
- ok OkTrueDef -
- 'type "file_comment" -
slack: '200200200AnyOf1223
Closed record
Fields
- team '200Team2 -
- ok OkTrueDef -
- user '200User2 -
slack: '200200AnyOf112
Closed record
Fields
- file FileObj -
- ok OkTrueDef -
- 'type "file" -
slack: '200200AnyOf12
Closed record
Fields
- count int -
- ok OkTrueDef -
slack: '200200AnyOf122
Closed record
Fields
- team '200Team1 -
- ok OkTrueDef -
- user '200User1 -
slack: '200AnyOf1
Closed record
Fields
- ok OkTrueDef -
- items '200Items[] -
slack: '200AnyOf11
Closed record
Fields
- channel ChannelDef -
- message MessageObj -
- ok OkTrueDef -
- 'type "message" -
slack: '200AnyOf12
Closed record
Fields
- team '200Team -
- ok OkTrueDef -
- user '200User -
slack: '200Team
Closed record
Fields
- id TeamDef -
slack: '200Team1
Closed record
Fields
- id TeamDef -
slack: '200Team2
Closed record
Fields
- id TeamDef -
slack: '200Team3
Closed record
Fields
- image132 string -
- image102 string -
- image68 string -
- imageDefault boolean -
- image34 string -
- domain string -
- image230 string -
- image44 string -
- image88 string -
- name string -
- id TeamDef -
slack: '200User
Closed record
Fields
- name string -
- id UserIdDef -
slack: '200User1
Closed record
Fields
- name string -
- id UserIdDef -
- email string -
slack: '200User2
Closed record
Fields
- image32 string -
- image24 string -
- name string -
- image192 string -
- id UserIdDef -
- image48 string -
- image72 string -
- image512 string -
slack: '200User3
Closed record
Fields
- name string -
- id UserIdDef -
slack: AdminAppsApproveBody
Fields
- teamId? string -
- appId? string - The id of the app to approve
- requestId? string - The id of the request to approve
slack: AdminAppsApprovedListQueries
Represents the Queries record for the operation: admin_apps_approved_list
Fields
- cursor? string - Set
cursortonext_cursorreturned by the previous call to list items in the next page
- 'limit? int - The maximum number of items to return. Must be between 1 - 1000 both inclusive
- teamId? string -
- enterpriseId? string -
slack: AdminAppsRequestsListQueries
Represents the Queries record for the operation: admin_apps_requests_list
Fields
- cursor? string - Set
cursortonext_cursorreturned by the previous call to list items in the next page
- 'limit? int - The maximum number of items to return. Must be between 1 - 1000 both inclusive
- teamId? string -
slack: AdminAppsRestrictBody
Fields
- teamId? string -
- appId? string - The id of the app to restrict
- requestId? string - The id of the request to restrict
slack: AdminAppsRestrictedListQueries
Represents the Queries record for the operation: admin_apps_restricted_list
Fields
- cursor? string - Set
cursortonext_cursorreturned by the previous call to list items in the next page
- 'limit? int - The maximum number of items to return. Must be between 1 - 1000 both inclusive
- teamId? string -
- enterpriseId? string -
slack: AdminConversationsArchiveBody
Fields
- channelId string - The channel to archive
slack: AdminConversationsArchiveResponse
Closed record
Schema for successful response of admin.conversations.archive
Fields
- ok OkTrueDef -
slack: AdminConversationsConvertToPrivateBody
Fields
- channelId string - The channel to convert to private
slack: AdminConversationsConvertToPrivateResponse
Closed record
Schema for successful response of admin.conversations.convertToPrivate
Fields
- ok OkTrueDef -
slack: AdminConversationsCreateBody
Fields
- isPrivate boolean - When
true, creates a private channel instead of a public channel
- orgWide? boolean - When
true, the channel will be available org-wide. Note: if the channel is notorg_wide=true, you must specify ateam_idfor this channel
- name string - Name of the public or private channel to create
- description? string - Description of the public or private channel to create
- teamId? string - The workspace to create the channel in. Note: this argument is required unless you set
org_wide=true
slack: AdminConversationsCreateResponse
Closed record
Schema for successful response of admin.conversations.create
Fields
- ok OkTrueDef -
- channelId? ChannelIdDef -
slack: AdminConversationsDeleteBody
Fields
- channelId string - The channel to delete
slack: AdminConversationsDeleteResponse
Closed record
Schema for successful response of admin.conversations.delete
Fields
- ok OkTrueDef -
slack: AdminConversationsDisconnectSharedBody
Fields
- channelId string - The channel to be disconnected from some workspaces
- leavingTeamIds? string - The team to be removed from the channel. Currently only a single team id can be specified
slack: AdminConversationsEkmListOriginalConnectedChannelInfoQueries
Represents the Queries record for the operation: admin_conversations_ekm_listOriginalConnectedChannelInfo
Fields
- channelIds? string - A comma-separated list of channels to filter to
- cursor? string - Set
cursortonext_cursorreturned by the previous call to list items in the next page
- teamIds? string - A comma-separated list of the workspaces to which the channels you would like returned belong
- 'limit? int - The maximum number of items to return. Must be between 1 - 1000 both inclusive
slack: AdminConversationsGetConversationPrefsQueries
Represents the Queries record for the operation: admin_conversations_getConversationPrefs
Fields
- channelId string - The channel to get preferences for
slack: AdminConversationsGetConversationPrefsResponse
Closed record
Schema for successful response of admin.conversations.getConversationPrefs
Fields
- ok OkTrueDef -
slack: AdminConversationsGetConversationPrefsResponsePrefs
Fields
slack: AdminConversationsGetConversationPrefsResponsePrefsCanThread
Fields
- 'type? string[] -
- user? string[] -
slack: AdminConversationsGetConversationPrefsResponsePrefsWhoCanPost
Fields
- 'type? string[] -
- user? string[] -
slack: AdminConversationsGetTeamsQueries
Represents the Queries record for the operation: admin_conversations_getTeams
Fields
- cursor? string - Set
cursortonext_cursorreturned by the previous call to list items in the next page
- 'limit? int - The maximum number of items to return. Must be between 1 - 1000 both inclusive
- channelId string - The channel to determine connected workspaces within the organization for
slack: AdminConversationsGetTeamsResponse
Closed record
Schema for successful response of admin.conversations.getTeams
Fields
- teamIds TeamDef[] -
- responseMetadata? AdminConversationsGetTeamsResponseResponseMetadata -
- ok OkTrueDef -
slack: AdminConversationsGetTeamsResponseResponseMetadata
Closed record
Fields
- nextCursor string -
slack: AdminConversationsInviteBody
Fields
- userIds string - The users to invite
- channelId string - The channel that the users will be invited to
slack: AdminConversationsInviteResponse
Closed record
Schema for successful response of admin.conversations.invite
Fields
- ok OkTrueDef -
slack: AdminConversationsRenameBody
Fields
- name string -
- channelId string - The channel to rename
slack: AdminConversationsRenameResponse
Closed record
Schema for successful response of admin.conversations.disconnectShared
Fields
- ok OkTrueDef -
slack: AdminConversationsRenameResponse1
Closed record
Schema for successful response of admin.conversations.rename
Fields
- ok OkTrueDef -
slack: AdminConversationsRestrictAccessAddGroupBody
Fields
- teamId? string - The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization
- channelId string - The channel to link this group to
- token string - Authentication token. Requires scope:
admin.conversations:write
slack: AdminConversationsRestrictAccessListGroupsQueries
Represents the Queries record for the operation: admin_conversations_restrictAccess_listGroups
Fields
- teamId? string - The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization
- channelId string -
slack: AdminConversationsRestrictAccessRemoveGroupBody
Fields
- teamId string - The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization
- channelId string - The channel to remove the linked group from
- token string - Authentication token. Requires scope:
admin.conversations:write
slack: AdminConversationsSearchQueries
Represents the Queries record for the operation: admin_conversations_search
Fields
- cursor? string - Set
cursortonext_cursorreturned by the previous call to list items in the next page
- searchChannelTypes? string - The type of channel to include or exclude in the search. For example
privatewill search private channels, whileprivate_excludewill exclude them. For a full list of types, check the Types section
- teamIds? string - Comma separated string of team IDs, signifying the workspaces to search through
- query? string - Name of the the channel to query by
- 'limit? int - Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10
- sort? string - Possible values are
relevant(search ranking based on what we think is closest),name(alphabetical),member_count(number of users in the channel), andcreated(date channel was created). You can optionally pair this with thesort_dirarg to change how it is sorted
- sortDir? string - Sort direction. Possible values are
ascfor ascending order like (1, 2, 3) or (a, b, c), anddescfor descending order like (3, 2, 1) or (c, b, a)
slack: AdminConversationsSearchResponse
Closed record
Schema for successful response of admin.conversations.search
Fields
- nextCursor string -
- channels ChannelObj[] -
slack: AdminConversationsSetConversationPrefsBody
Fields
- channelId string - The channel to set the prefs for
- prefs string - The prefs for this channel in a stringified JSON format
slack: AdminConversationsSetConversationPrefsResponse
Closed record
Schema for successful response of admin.conversations.setConversationPrefs
Fields
- ok OkTrueDef -
slack: AdminConversationsSetTeamsBody
Fields
- orgChannel? boolean - True if channel has to be converted to an org channel
- targetTeamIds? string - A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide
- teamId? string - The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel
- channelId string - The encoded
channel_idto add or remove to workspaces
slack: AdminConversationsUnarchiveBody
Fields
- channelId string - The channel to unarchive
slack: AdminConversationsUnarchiveResponse
Closed record
Schema for successful response of admin.conversations.unarchive
Fields
- ok OkTrueDef -
slack: AdminEmojiAddAliasBody
Fields
- aliasFor string - The alias of the emoji
- name string - The name of the emoji to be aliased. Colons (
:myemoji:) around the value are not required, although they may be included
- token string - Authentication token. Requires scope:
admin.teams:write
slack: AdminEmojiAddBody
Fields
- name string - The name of the emoji to be removed. Colons (
:myemoji:) around the value are not required, although they may be included
- url string - The URL of a file to use as an image for the emoji. Square images under 128KB and with transparent backgrounds work best
- token string - Authentication token. Requires scope:
admin.teams:write
slack: AdminEmojiListQueries
Represents the Queries record for the operation: admin_emoji_list
Fields
- cursor? string - Set
cursortonext_cursorreturned by the previous call to list items in the next page
- 'limit? int - The maximum number of items to return. Must be between 1 - 1000 both inclusive
slack: AdminEmojiRemoveBody
Fields
- name string - The name of the emoji to be removed. Colons (
:myemoji:) around the value are not required, although they may be included
- token string - Authentication token. Requires scope:
admin.teams:write
slack: AdminEmojiRenameBody
Fields
- name string - The name of the emoji to be renamed. Colons (
:myemoji:) around the value are not required, although they may be included
- newName string - The new name of the emoji
- token string - Authentication token. Requires scope:
admin.teams:write
slack: AdminInviteRequestsApprovedListQueries
Represents the Queries record for the operation: admin_inviteRequests_approved_list
Fields
- cursor? string - Value of the
next_cursorfield sent as part of the previous API response
- 'limit? int - The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive
- teamId? string - ID for the workspace where the invite requests were made
slack: AdminInviteRequestsDeniedListQueries
Represents the Queries record for the operation: admin_inviteRequests_denied_list
Fields
- cursor? string - Value of the
next_cursorfield sent as part of the previous api response
- 'limit? int - The number of results that will be returned by the API on each invocation. Must be between 1 - 1000 both inclusive
- teamId? string - ID for the workspace where the invite requests were made
slack: AdminInviteRequestsListQueries
Represents the Queries record for the operation: admin_inviteRequests_list
Fields
- cursor? string - Value of the
next_cursorfield sent as part of the previous API response
- 'limit? int - The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive
- teamId? string - ID for the workspace where the invite requests were made
slack: AdminTeamsAdminsListQueries
Represents the Queries record for the operation: admin_teams_admins_list
Fields
- cursor? string - Set
cursortonext_cursorreturned by the previous call to list items in the next page
- 'limit? int - The maximum number of items to return
- teamId string -
slack: AdminTeamsCreateBody
Fields
- teamDescription? string - Description for the team
- teamDomain string - Team domain (for example, slacksoftballteam)
- teamName string - Team name (for example, Slack Softball Team)
- teamDiscoverability? string - Who can join the team. A team's discoverability can be
open,closed,invite_only, orunlisted
slack: AdminTeamsListQueries
Represents the Queries record for the operation: admin_teams_list
Fields
- cursor? string - Set
cursortonext_cursorreturned by the previous call to list items in the next page
- 'limit? int - The maximum number of items to return. Must be between 1 - 100 both inclusive
slack: AdminTeamsOwnersListQueries
Represents the Queries record for the operation: admin_teams_owners_list
Fields
- cursor? string - Set
cursortonext_cursorreturned by the previous call to list items in the next page
- 'limit? int - The maximum number of items to return. Must be between 1 - 1000 both inclusive
- teamId string -
slack: AdminTeamsSettingsInfoQueries
Represents the Queries record for the operation: admin_teams_settings_info
Fields
- teamId string -
slack: AdminTeamsSettingsSetDefaultChannelsBody
Fields
- channelIds string - An array of channel IDs
- teamId string - ID for the workspace to set the default channel for
- token string - Authentication token. Requires scope:
admin.teams:write
slack: AdminTeamsSettingsSetDescriptionBody
Fields
- description string - The new description for the workspace
- teamId string - ID for the workspace to set the description for
slack: AdminTeamsSettingsSetDiscoverabilityBody
Fields
- discoverability string - This workspace's discovery setting. It must be set to one of
open,invite_only,closed, orunlisted
- teamId string - The ID of the workspace to set discoverability on
slack: AdminTeamsSettingsSetIconBody
Fields
- imageUrl string - Image URL for the icon
- teamId string - ID for the workspace to set the icon for
- token string - Authentication token. Requires scope:
admin.teams:write
slack: AdminTeamsSettingsSetNameBody
Fields
- name string - The new name of the workspace
- teamId string - ID for the workspace to set the name for
slack: AdminUsergroupsAddChannelsBody
Fields
- channelIds string - Comma separated string of channel IDs
- usergroupId string - ID of the IDP group to add default channels for
- teamId? string - The workspace to add default channels in
slack: AdminUsergroupsAddTeamsBody
Fields
- teamIds string - A comma separated list of encoded team (workspace) IDs. Each workspace MUST belong to the organization associated with the token
- usergroupId string - An encoded usergroup (IDP Group) ID
- autoProvision? boolean - When
true, this method automatically creates new workspace accounts for the IDP group members
slack: AdminUsergroupsListChannelsQueries
Represents the Queries record for the operation: admin_usergroups_listChannels
Fields
- includeNumMembers? boolean - Flag to include or exclude the count of members per channel
- usergroupId string - ID of the IDP group to list default channels for
- teamId? string - ID of the the workspace
slack: AdminUsergroupsRemoveChannelsBody
Fields
- channelIds string - Comma-separated string of channel IDs
- usergroupId string - ID of the IDP Group
slack: AdminUsersAssignBody
Fields
- channelIds? string - Comma separated values of channel IDs to add user in the new workspace
- isUltraRestricted? boolean - True if user should be added to the workspace as a single-channel guest
- userId string - The ID of the user to add to the workspace
- isRestricted? boolean - True if user should be added to the workspace as a guest
- teamId string - The ID (
T1234) of the workspace
slack: AdminUsersInviteBody
Fields
- channelIds string - A comma-separated list of
channel_ids for this user to join. At least one channel is required
- isUltraRestricted? boolean - Is this user a single channel guest user? (default: false)
- customMessage? string - An optional message to send to the user in the invite email
- guestExpirationTs? string - Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date
- isRestricted? boolean - Is this user a multi-channel guest user? (default: false)
- resend? boolean - Allow this invite to be resent in the future if a user has not signed up yet. (default: false)
- realName? string - Full name of the user
- teamId string - The ID (
T1234) of the workspace
- email string - The email address of the person to invite
slack: AdminUsersListQueries
Represents the Queries record for the operation: admin_users_list
Fields
- cursor? string - Set
cursortonext_cursorreturned by the previous call to list items in the next page
- 'limit? int - Limit for how many users to be retrieved per page
- teamId string - The ID (
T1234) of the workspace
slack: AdminUsersRemoveBody
Fields
- userId string - The ID of the user to remove
- teamId string - The ID (
T1234) of the workspace
slack: AdminUsersSessionInvalidateBody
Fields
- sessionId int -
- teamId string - ID of the team that the session belongs to
slack: AdminUsersSessionResetBody
Fields
- userId string - The ID of the user to wipe sessions for
- mobileOnly? boolean - Only expire mobile sessions (default: false)
- webOnly? boolean - Only expire web sessions (default: false)
slack: AdminUsersSetAdminBody
Fields
- userId string - The ID of the user to designate as an admin
- teamId string - The ID (
T1234) of the workspace
slack: AdminUsersSetExpirationBody
Fields
- expirationTs int - Timestamp when guest account should be disabled
- userId string - The ID of the user to set an expiration for
- teamId string - The ID (
T1234) of the workspace
slack: AdminUsersSetOwnerBody
Fields
- userId string - Id of the user to promote to owner
- teamId string - The ID (
T1234) of the workspace
slack: AdminUsersSetOwnerHeaders
Represents the Headers record for the operation: admin_users_setOwner
Fields
- token string - Authentication token. Requires scope:
admin.users:write
slack: AdminUsersSetRegularBody
Fields
- userId string - The ID of the user to designate as a regular user
- teamId string - The ID (
T1234) of the workspace
slack: APIMethodUsersGetPresence
Generated from users.getPresence with shasum e7251aec575d8863f9e0eb38663ae9dc26655f65
Fields
- auto_away? boolean -
- connection_count? int -
- last_activity? int -
- manual_away? boolean -
- ok OkTrueDef -
- online? boolean -
- presence string -
slack: ApiPermissionsScopesListResponse
Schema for successful response api.permissions.scopes.list method
Fields
- ok OkTrueDef -
slack: ApiPermissionsScopesListResponseScopes
Fields
- app_home? ScopesObj -
- channel? ScopesObj -
- group? ScopesObj -
- im? ScopesObj -
- mpim? ScopesObj -
- team? ScopesObj -
- user? ScopesObj -
slack: ApiTestQueries
Represents the Queries record for the operation: api_test
Fields
- foo? string - example property to return
slack: ApiTestResponse
Schema for successful response api.test method
Fields
- ok OkTrueDef -
- record {}... - Rest field
slack: AppsEventAuthorizationsListQueries
Represents the Queries record for the operation: apps_event_authorizations_list
Fields
- cursor? string -
- 'limit? int -
- eventContext string -
slack: AppsPermissionsInfoResponse
Closed record
Schema for successful response from apps.permissions.info method
Fields
- ok OkTrueDef -
slack: AppsPermissionsInfoResponseInfo
Fields
- channel AppsPermissionsInfoResponseInfoChannel -
- appHome AppsPermissionsInfoResponseInfoAppHome -
slack: AppsPermissionsInfoResponseInfoAppHome
Fields
- resources? ResourcesObj -
- scopes? ScopesObj -
slack: AppsPermissionsInfoResponseInfoChannel
Fields
- resources? ResourcesObj -
- scopes? ScopesObj -
slack: AppsPermissionsInfoResponseInfoGroup
Fields
- resources? ResourcesObj -
- scopes? ScopesObj -
slack: AppsPermissionsInfoResponseInfoIm
Fields
- resources? ResourcesObj -
- scopes? ScopesObj -
slack: AppsPermissionsInfoResponseInfoMpim
Fields
- resources? ResourcesObj -
- scopes? ScopesObj -
slack: AppsPermissionsInfoResponseInfoTeam
Fields
- resources ResourcesObj -
- scopes ScopesObj -
slack: AppsPermissionsRequestQueries
Represents the Queries record for the operation: apps_permissions_request
Fields
- triggerId string - Token used to trigger the permissions API
- scopes string - A comma separated list of scopes to request for
slack: AppsPermissionsRequestResponse
Closed record
Schema for successful response from apps.permissions.request method
Fields
- ok OkTrueDef -
slack: AppsPermissionsResourcesListQueries
Represents the Queries record for the operation: apps_permissions_resources_list
Fields
- cursor? string - Paginate through collections of data by setting the
cursorparameter to anext_cursorattribute returned by a previous request'sresponse_metadata. Default value fetches the first "page" of the collection. See pagination for more detail
- 'limit? int - The maximum number of items to return
slack: AppsPermissionsResourcesListResponse
Schema for successful response apps.permissions.resources.list method
Fields
- ok OkTrueDef -
- resources AppsPermissionsResourcesListResponseResources[] -
- response_metadata? AppsPermissionsResourcesListResponseResponseMetadata -
slack: AppsPermissionsResourcesListResponseResources
Fields
- id? string -
- 'type? string -
slack: AppsPermissionsResourcesListResponseResponseMetadata
Closed record
Fields
- nextCursor string -
slack: AppsPermissionsUsersListQueries
Represents the Queries record for the operation: apps_permissions_users_list
Fields
- cursor? string - Paginate through collections of data by setting the
cursorparameter to anext_cursorattribute returned by a previous request'sresponse_metadata. Default value fetches the first "page" of the collection. See pagination for more detail
- 'limit? int - The maximum number of items to return
slack: AppsPermissionsUsersRequestQueries
Represents the Queries record for the operation: apps_permissions_users_request
Fields
- triggerId string - Token used to trigger the request
- scopes string - A comma separated list of user scopes to request for
- user string - The user this scope is being requested for
slack: AppsUninstallQueries
Represents the Queries record for the operation: apps_uninstall
Fields
- clientSecret? string - Issued when you created your application
- clientId? string - Issued when you created your application
slack: AppsUninstallResponse
Closed record
Schema for successful response from apps.uninstall method
Fields
- ok OkTrueDef -
slack: AuthRevokeQueries
Represents the Queries record for the operation: auth_revoke
Fields
- test? boolean - Setting this parameter to
1triggers a testing mode where the specified token will not actually be revoked
slack: AuthRevokeResponse
Closed record
Schema for successful response from auth.revoke method
Fields
- ok OkTrueDef -
- revoked boolean -
slack: AuthTestResponse
Closed record
Schema for successful response auth.test method
Fields
- userId UserIdDef -
- isEnterpriseInstall? boolean -
- team string -
- teamId TeamDef -
- ok OkTrueDef -
- user string -
- botId? BotIdDef -
- url string -
slack: BlocksInner
Fields
- 'type string -
slack: BotProfileObj
Closed record
Fields
- deleted boolean -
- name string -
- id BotIdDef -
- teamId TeamDef -
- icons BotProfileObjIcons -
- appId AppIdDef -
- updated int -
slack: BotProfileObjIcons
Closed record
Fields
- image36 string -
- image48 string -
- image72 string -
slack: BotsInfoQueries
Represents the Queries record for the operation: bots_info
Fields
- bot? string - Bot user to get info on
slack: BotsInfoResponse
Closed record
Schema for successful response from bots.info method
Fields
- bot BotsInfoResponseBot -
- ok OkTrueDef -
slack: BotsInfoResponseBot
Closed record
Fields
- deleted boolean -
- userId? UserIdDef -
- name string -
- id BotIdDef -
- icons BotsInfoResponseBotIcons -
- appId AppIdDef -
- updated int -
slack: BotsInfoResponseBotIcons
Closed record
Fields
- image36 string -
- image48 string -
- image72 string -
slack: CallsAddBody
Fields
- dateStart? int - Call start time in UTC UNIX timestamp format
- joinUrl string - The URL required for a client to join the Call
- desktopAppJoinUrl? string - When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL
- externalDisplayId? string - An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object
- externalUniqueId string - An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service
- title? string - The name of the Call
- createdBy? string - The valid Slack user ID of the user who created this Call. When this method is called with a user token, the
created_byfield is optional and defaults to the authed user of the token. Otherwise, the field is required
- users? string - The list of users to register as participants in the Call. Read more on how to specify users here
slack: CallsEndBody
Fields
- duration? int - Call duration in seconds
slack: CallsInfoQueries
Represents the Queries record for the operation: calls_info
Fields
slack: CallsParticipantsAddBody
Fields
- users string - The list of users to add as participants in the Call. Read more on how to specify users here
slack: CallsParticipantsRemoveBody
Fields
- users string - The list of users to remove as participants in the Call. Read more on how to specify users here
slack: CallsUpdateBody
Fields
- joinUrl? string - The URL required for a client to join the Call
- desktopAppJoinUrl? string - When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL
- title? string - The name of the Call
slack: ChannelAnyOf2
Closed record
Fields
- lastRead? TsDef -
- unreadCount? decimal -
- isIm? boolean -
- isOpen? boolean -
- created? string -
- id DmIdDef -
- unreadCountDisplay? decimal -
- user? UserIdDef -
- latest? MessageObj -
slack: ChannelObj
Closed record
Fields
- isPrivate boolean -
- acceptedUser? UserIdDef -
- purpose ChannelObjPurpose -
- isMoved? int -
- unreadCount? int -
- isChannel boolean -
- members UserIdDef[] -
- isNonThreadable? boolean -
- isReadOnly? boolean -
- id ChannelIdDef -
- previousNames? ChannelNameDef[] -
- latest? ChannelObjLatest[] -
- lastRead? TsDef -
- creator UserIdDef -
- isFrozen? boolean -
- isMember? boolean -
- isMpim boolean -
- created int -
- nameNormalized string -
- priority? decimal -
- unreadCountDisplay? int -
- unlinked? int -
- isArchived? boolean -
- isGeneral? boolean -
- numMembers? int -
- name string -
- topic ChannelObjTopic -
- isThreadOnly? boolean -
slack: ChannelObjPurpose
Closed record
Fields
- lastSet int -
- creator TopicPurposeCreatorDef -
- value string -
slack: ChannelObjTopic
Closed record
Fields
- lastSet int -
- creator TopicPurposeCreatorDef -
- value string -
slack: ChatDeleteBody
Fields
- channel? string - Channel containing the message to be deleted
- ts? decimal - Timestamp of the message to be deleted
slack: ChatDeleteResponse
Closed record
Schema for successful response of chat.delete method
Fields
- channel ChannelDef -
- ok OkTrueDef -
- ts TsDef -
slack: ChatDeleteScheduledMessageBody
Fields
- scheduledMessageId string -
scheduled_message_idreturned from call to chat.scheduleMessage
- channel string - The channel the scheduled_message is posting to
slack: ChatDeleteScheduledMessageResponse
Closed record
Schema for successful response from chat.deleteScheduledMessage method
Fields
- ok OkTrueDef -
slack: ChatGetPermalinkQueries
Represents the Queries record for the operation: chat_getPermalink
Fields
- channel string - The ID of the conversation or channel containing the message
- messageTs string - A message's
tsvalue, uniquely identifying it within a channel
slack: ChatGetPermalinkResponse
Closed record
Schema for successful response chat.getPermalink
Fields
- channel ChannelDef -
- ok OkTrueDef -
- permalink string -
slack: ChatMeMessageBody
Fields
- channel? string - Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name
- text? string - Text of the message to send
slack: ChatMeMessageResponse
Closed record
Schema for successful response from chat.meMessage method
Fields
- channel? ChannelDef -
- ok OkTrueDef -
- ts? TsDef -
slack: ChatPostEphemeralBody
Fields
- iconUrl? string - URL to an image to use as the icon for this message. Must be used in conjunction with
as_userset to false, otherwise ignored. See authorship below
- linkNames? boolean - Find and link channel names and usernames
- asUser? boolean - Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false
- attachments? string - A JSON-based array of structured attachments, presented as a URL-encoded string
- iconEmoji? string - Emoji to use as the icon for this message. Overrides
icon_url. Must be used in conjunction withas_userset tofalse, otherwise ignored. See authorship below
- blocks? string - A JSON-based array of structured blocks, presented as a URL-encoded string
- threadTs? string - Provide another message's
tsvalue to post this message in a thread. Avoid using a reply'stsvalue; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread
- channel string - Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name
- user string -
idof the user who will receive the ephemeral message. The user should be in the channel specified by thechannelargument
- username? string - Set your bot's user name. Must be used in conjunction with
as_userset to false, otherwise ignored. See authorship below
slack: ChatPostEphemeralResponse
Closed record
Schema for successful response from chat.postEphemeral method
Fields
- ok OkTrueDef -
- messageTs TsDef -
slack: ChatPostMessageBody
Fields
- iconUrl? string - URL to an image to use as the icon for this message. Must be used in conjunction with
as_userset to false, otherwise ignored. See authorship below
- linkNames? boolean - Find and link channel names and usernames
- attachments? string - A JSON-based array of structured attachments, presented as a URL-encoded string
- iconEmoji? string - Emoji to use as the icon for this message. Overrides
icon_url. Must be used in conjunction withas_userset tofalse, otherwise ignored. See authorship below
- blocks? string - A JSON-based array of structured blocks, presented as a URL-encoded string
- mrkdwn? boolean - Disable Slack markup parsing by setting to
false. Enabled by default
- asUser? string - Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below
- threadTs? string - Provide another message's
tsvalue to make this message a reply. Avoid using a reply'stsvalue; use its parent instead
- unfurlMedia? boolean - Pass false to disable unfurling of media content
- replyBroadcast? boolean - Used in conjunction with
thread_tsand indicates whether reply should be made visible to everyone in the channel or conversation. Defaults tofalse
- unfurlLinks? boolean - Pass true to enable unfurling of primarily text-based content
- username? string - Set your bot's user name. Must be used in conjunction with
as_userset to false, otherwise ignored. See authorship below
slack: ChatPostMessageResponse
Closed record
Schema for successful response of chat.postMessage method
Fields
- channel ChannelDef -
- message MessageObj -
- ok OkTrueDef -
- ts TsDef -
slack: ChatScheduledMessagesListQueries
Represents the Queries record for the operation: chat_scheduledMessages_list
Fields
- cursor? string - For pagination purposes, this is the
cursorvalue returned from a previous call tochat.scheduledmessages.listindicating where you want to start this call from
- oldest? decimal - A UNIX timestamp of the oldest value in the time range
- channel? string - The channel of the scheduled messages
- 'limit? int - Maximum number of original entries to return
- latest? decimal - A UNIX timestamp of the latest value in the time range
slack: ChatScheduledMessagesListResponse
Closed record
Schema for successful response from chat.scheduledMessages.list method
Fields
- scheduledMessages ChatScheduledMessagesListResponseScheduledMessages[] -
- responseMetadata ChatScheduledMessagesListResponseResponseMetadata -
- ok OkTrueDef -
slack: ChatScheduledMessagesListResponseResponseMetadata
Closed record
Fields
- nextCursor string -
slack: ChatScheduledMessagesListResponseScheduledMessages
Closed record
Fields
- dateCreated int -
- id string -
- text? string -
- postAt int -
- channelId ChannelIdDef -
slack: ChatScheduleMessageBody
Fields
- linkNames? boolean - Find and link channel names and usernames
- asUser? boolean - Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See chat.postMessage
- attachments? string - A JSON-based array of structured attachments, presented as a URL-encoded string
- blocks? string - A JSON-based array of structured blocks, presented as a URL-encoded string
- threadTs? decimal - Provide another message's
tsvalue to make this message a reply. Avoid using a reply'stsvalue; use its parent instead
- unfurlMedia? boolean - Pass false to disable unfurling of media content
- replyBroadcast? boolean - Used in conjunction with
thread_tsand indicates whether reply should be made visible to everyone in the channel or conversation. Defaults tofalse
- unfurlLinks? boolean - Pass true to enable unfurling of primarily text-based content
- parse? string - Change how messages are treated. Defaults to
none. See chat.postMessage
- postAt? string - Unix EPOCH timestamp of time in future to send the message
slack: ChatScheduleMessageResponse
Closed record
Schema for successful response of chat.scheduleMessage method
Fields
- scheduledMessageId string -
- channel ChannelDef -
- message ChatScheduleMessageResponseMessage -
- ok OkTrueDef -
- postAt int -
slack: ChatScheduleMessageResponseMessage
Closed record
Fields
- botProfile? BotProfileObj -
- team TeamDef -
- text string -
- 'type string -
- user UserIdDef -
- botId BotIdDef -
- username? string -
slack: ChatUnfurlBody
Fields
- unfurls? string - URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments
- userAuthMessage? string - Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior
- channel string - Channel ID of the message
- userAuthUrl? string - Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded
- userAuthRequired? boolean - Set to
trueor1to indicate the user must install your Slack app to trigger unfurls for this domain
- ts string - Timestamp of the message to add unfurl behavior to
slack: ChatUnfurlResponse
Closed record
Schema for successful response from chat.unfurl method
Fields
- ok OkTrueDef -
slack: ChatUpdateBody
Fields
- linkNames? string - Find and link channel names and usernames. Defaults to
none. If you do not specify a value for this field, the original value set for the message will be overwritten with the default,none
- attachments? string - A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting
text. If you don't include this field, the message's previousattachmentswill be retained. To remove previousattachments, include an empty array for this field
- blocks? string - A JSON-based array of structured blocks, presented as a URL-encoded string. If you don't include this field, the message's previous
blockswill be retained. To remove previousblocks, include an empty array for this field
- channel string - Channel containing the message to be updated
- parse? string - Change how messages are treated. Defaults to
client, unlikechat.postMessage. Accepts eithernoneorfull. If you do not specify a value for this field, the original value set for the message will be overwritten with the default,client
- text? string - New text for the message, using the default formatting rules. It's not required when presenting
blocksorattachments
- ts string - Timestamp of the message to be updated
slack: ChatUpdateResponse
Closed record
Schema for successful response of chat.update method
Fields
- channel string -
- text string -
- message MessageObject -
- ok OkTrueDef -
- ts string -
slack: CommentObj
Closed record
Fields
- isStarred? boolean -
- created int -
- numStars? int -
- isIntro boolean -
- pinnedInfo? PinnedInfoDef -
- comment string -
- reactions? ReactionObj[] -
- id CommentIdDef -
- user UserIdDef -
- pinnedTo? ChannelDef[] -
- timestamp int -
slack: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
slack: ConversationIMChannelObjectFromConversationsMethods
Closed record
Fields
- hasPins? boolean -
- lastRead? TsDef -
- isUserDeleted? boolean -
- isFrozen? boolean -
- isIm boolean -
- isOpen? boolean -
- created int -
- priority decimal -
- unreadCountDisplay? int -
- version? int -
- unreadCount? int -
- isStarred? boolean -
- isArchived? boolean -
- pinCount? int -
- id DmIdDef -
- user UserIdDef -
- latest? ConversationObjLatest2[] -
- parentConversation? ConversationObjParentConversation2[] -
slack: ConversationMPIMObject
Closed record
Fields
- internalTeamIds? TeamDef[] -
- isChannel boolean -
- members? UserIdDef[] -
- isNonThreadable? boolean -
- pinCount? int -
- isReadOnly? boolean -
- id ChannelDef -
- isIm boolean -
- isMember? boolean -
- isOpen? boolean -
- created int -
- displayCounts? ConversationObjDisplayCounts1 -
- priority? decimal -
- version? int -
- isStarred? boolean -
- isArchived boolean -
- name string -
- topic ConversationObjTopic1 -
- isPrivate boolean -
- acceptedUser? UserIdDef -
- conversationHostId? WorkspaceIdDef -
- purpose ConversationObjPurpose1 -
- isMoved? int -
- unreadCount? int -
- previousNames? ChannelNameDef[] -
- connectedTeamIds? TeamDef[] -
- pendingConnectedTeamIds? TeamDef[] -
- latest? ConversationObjLatest1[] -
- lastRead? TsDef -
- creator UserIdDef -
- isFrozen? boolean -
- isMpim true -
- timezoneCount? int -
- nameNormalized string -
- unreadCountDisplay? int -
- isGroup boolean -
- unlinked? int -
- isGeneral boolean -
- numMembers? int -
- isThreadOnly? boolean -
- user? UserIdDef -
- parentConversation? ConversationObjParentConversation1[] -
slack: ConversationObjDisplayCounts
Closed record
Fields
- displayCounts int -
- guestCounts int -
slack: ConversationObjDisplayCounts1
Closed record
Fields
- displayCounts int -
- guestCounts int -
slack: ConversationObject
Closed record
Fields
- internalTeamIds? TeamDef[] -
- isChannel boolean -
- members? UserIdDef[] -
- isNonThreadable? boolean -
- pinCount? int -
- isReadOnly? boolean -
- id ChannelDef -
- isOrgDefault? boolean -
- isOrgMandatory? boolean -
- isIm boolean -
- isMember? boolean -
- isOpen? boolean -
- created int -
- displayCounts? ConversationObjDisplayCounts -
- priority? decimal -
- version? int -
- isStarred? boolean -
- isArchived boolean -
- name string -
- topic ConversationObjTopic -
- isPrivate boolean -
- acceptedUser? UserIdDef -
- conversationHostId? WorkspaceIdDef -
- purpose ConversationObjPurpose -
- isMoved? int -
- unreadCount? int -
- previousNames? ChannelNameDef[] -
- connectedTeamIds? WorkspaceIdDef[] -
- pendingConnectedTeamIds? TeamDef[] -
- latest? ConversationObjLatest[] -
- hasPins? boolean -
- lastRead? TsDef -
- creator UserIdDef -
- isFrozen? boolean -
- isMpim false -
- timezoneCount? int -
- nameNormalized string -
- enterpriseId? EnterpriseIdDef -
- unreadCountDisplay? int -
- isGroup boolean -
- unlinked? int -
- useCase? string -
- isGeneral boolean -
- numMembers? int -
- isThreadOnly? boolean -
- user? UserIdDef -
- parentConversation? ConversationObjParentConversation[] -
slack: ConversationObjPurpose
Closed record
Fields
- lastSet int -
- creator TopicPurposeCreatorDef -
- value string -
slack: ConversationObjPurpose1
Closed record
Fields
- lastSet int -
- creator TopicPurposeCreatorDef -
- value string -
slack: ConversationObjShares
Closed record
Fields
- isActive boolean -
- acceptedUser? UserIdDef -
- team TeamObj -
- user UserIdDef -
slack: ConversationObjShares1
Closed record
Fields
- isActive boolean -
- acceptedUser? UserIdDef -
- team TeamObj -
- user UserIdDef -
slack: ConversationObjShares2
Closed record
Fields
- isActive boolean -
- dateCreate int -
- name string -
- id TeamDef -
- team TeamObj -
slack: ConversationObjTopic
Closed record
Fields
- lastSet int -
- creator TopicPurposeCreatorDef -
- value string -
slack: ConversationObjTopic1
Closed record
Fields
- lastSet int -
- creator TopicPurposeCreatorDef -
- value string -
slack: ConversationsArchiveBody
Fields
- channel? string - ID of conversation to archive
slack: ConversationsArchiveResponse
Closed record
Schema for successful response conversations.archive method
Fields
- ok OkTrueDef -
slack: ConversationsCloseBody
Fields
- channel? string - Conversation to close
slack: ConversationsCloseResponse
Closed record
Schema for successful response conversations.close method
Fields
- alreadyClosed? boolean -
- ok OkTrueDef -
- noOp? boolean -
slack: ConversationsCreateBody
Fields
- isPrivate? boolean - Create a private channel instead of a public one
- name? string - Name of the public or private channel to create
slack: ConversationsCreateResponse
Closed record
Schema for successful response conversations.create method
Fields
- channel ConversationObj -
- ok OkTrueDef -
slack: ConversationsHistoryQueries
Represents the Queries record for the operation: conversations_history
Fields
- cursor? string - Paginate through collections of data by setting the
cursorparameter to anext_cursorattribute returned by a previous request'sresponse_metadata. Default value fetches the first "page" of the collection. See pagination for more detail
- inclusive? boolean - Include messages with latest or oldest timestamp in results only when either timestamp is specified
- oldest? decimal - Start of time range of messages to include in results
- channel? string - Conversation ID to fetch history for
- 'limit? int - The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached
- latest? decimal - End of time range of messages to include in results
slack: ConversationsHistoryResponse
Closed record
Schema for successful response from conversations.history method
Fields
- channelActionsCount int -
- pinCount int -
- messages MessageObj[] -
- channelActionsTs ConversationsHistoryResponseChannelActionsTs[] -
- hasMore boolean -
- ok OkTrueDef -
slack: ConversationsInfoQueries
Represents the Queries record for the operation: conversations_info
Fields
- includeNumMembers? boolean - Set to
trueto include the member count for the specified conversation. Defaults tofalse
- channel? string - Conversation ID to learn more about
- includeLocale? boolean - Set this to
trueto receive the locale for this conversation. Defaults tofalse
slack: ConversationsInfoResponse
Closed record
Schema for successful response conversations.info
Fields
- channel ConversationObj -
- ok OkTrueDef -
slack: ConversationsInviteBody
Fields
- channel? string - The ID of the public or private channel to invite user(s) to
- users? string - A comma separated list of user IDs. Up to 1000 users may be listed
slack: ConversationsInviteErrorResponse
Closed record
Schema for successful response from conversations.invite method
Fields
- channel ConversationObj -
- ok OkTrueDef -
slack: ConversationsJoinBody
Fields
- channel? string - ID of conversation to join
slack: ConversationsJoinResponse
Closed record
Schema for successful response from conversations.join method
Fields
- channel ConversationObj -
- warning? string -
- responseMetadata? ResponseMetadata -
- ok OkTrueDef -
slack: ConversationsKickBody
Fields
- channel? string - ID of conversation to remove user from
- user? string - User ID to be removed
slack: ConversationsKickResponse
Closed record
Schema for successful response conversations.kick method
Fields
- ok OkTrueDef -
slack: ConversationsLeaveBody
Fields
- channel? string - Conversation to leave
slack: ConversationsLeaveResponse
Closed record
Schema for successful response from conversations.leave method
Fields
- ok OkTrueDef -
- notInChannel? true -
slack: ConversationsListQueries
Represents the Queries record for the operation: conversations_list
Fields
- cursor? string - Paginate through collections of data by setting the
cursorparameter to anext_cursorattribute returned by a previous request'sresponse_metadata. Default value fetches the first "page" of the collection. See pagination for more detail
- types? string - Mix and match channel types by providing a comma-separated list of any combination of
public_channel,private_channel,mpim,im
- 'limit? int - The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000
- excludeArchived? boolean - Set to
trueto exclude archived channels from the list
slack: ConversationsListResponse
Closed record
Schema for successful response from conversations.list method
Fields
- channels ConversationObj[] -
- responseMetadata? ConversationsListResponseResponseMetadata -
- ok OkTrueDef -
slack: ConversationsListResponseResponseMetadata
Closed record
Fields
- nextCursor string -
slack: ConversationsMarkBody
Fields
- channel? string - Channel or conversation to set the read cursor for
- ts? decimal - Unique identifier of message you want marked as most recently seen in this conversation
slack: ConversationsMarkResponse
Closed record
Schema for successful response conversations.mark method
Fields
- ok OkTrueDef -
slack: ConversationsMembersQueries
Represents the Queries record for the operation: conversations_members
Fields
- cursor? string - Paginate through collections of data by setting the
cursorparameter to anext_cursorattribute returned by a previous request'sresponse_metadata. Default value fetches the first "page" of the collection. See pagination for more detail
- channel? string - ID of the conversation to retrieve members for
- 'limit? int - The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached
slack: ConversationsMembersResponse
Closed record
Schema for successful response conversations.members method
Fields
- members UserIdDef[] -
- responseMetadata ConversationsMembersResponseResponseMetadata -
- ok OkTrueDef -
slack: ConversationsMembersResponseResponseMetadata
Closed record
Fields
- nextCursor string -
slack: ConversationsOpenBody
Fields
- returnIm? boolean - Boolean, indicates you want the full IM channel definition in the response
- channel? string - Resume a conversation by supplying an
imormpim's ID. Or provide theusersfield instead
- users? string - Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a
channelwhen not supplyingusers
slack: ConversationsOpenResponse
Closed record
Schema for successful response from conversations.open method when opening channels, ims, mpims
Fields
- alreadyOpen? boolean -
- channel ConversationsOpenResponseChannel[] -
- ok OkTrueDef -
- noOp? boolean -
slack: ConversationsRenameBody
Fields
- channel? string - ID of conversation to rename
- name? string - New name for conversation
slack: ConversationsRenameResponse
Closed record
Schema for successful response from conversations.rename method
Fields
- channel ConversationObj -
- ok OkTrueDef -
slack: ConversationsRepliesQueries
Represents the Queries record for the operation: conversations_replies
Fields
- cursor? string - Paginate through collections of data by setting the
cursorparameter to anext_cursorattribute returned by a previous request'sresponse_metadata. Default value fetches the first "page" of the collection. See pagination for more detail
- inclusive? boolean - Include messages with latest or oldest timestamp in results only when either timestamp is specified
- oldest? decimal - Start of time range of messages to include in results
- channel? string - Conversation ID to fetch thread from
- 'limit? int - The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached
- ts? decimal - Unique identifier of a thread's parent message.
tsmust be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced bytswill return - it is just an ordinary, unthreaded message
- latest? decimal - End of time range of messages to include in results
slack: ConversationsRepliesResponse
Closed record
Schema for successful response from conversations.replies method
Fields
- messages (record {| last_read TsDef, latest_reply TsDef, reply_count int, reply_users UserIdDef[], reply_users_count int, source_team TeamDef, subscribed boolean, team TeamDef, text string, thread_ts TsDef, ts TsDef, 'type string, unread_count int, user UserIdDef, user_profile UserProfileShortObj, user_team TeamDef |}|record {| is_starred boolean, parent_user_id UserIdDef, source_team TeamDef, team TeamDef, text string, thread_ts TsDef, ts TsDef, 'type string, user UserIdDef, user_profile UserProfileShortObj, user_team TeamDef |})[][] -
- hasMore? boolean -
- ok OkTrueDef -
slack: ConversationsSetPurposeBody
Fields
- purpose? string - A new, specialer purpose
- channel? string - Conversation to set the purpose of
slack: ConversationsSetPurposeResponse
Closed record
Schema for successful response from conversations.setPurpose method
Fields
- channel ConversationObj -
- ok OkTrueDef -
slack: ConversationsSetTopicBody
Fields
- channel? string - Conversation to set the topic of
- topic? string - The new topic string. Does not support formatting or linkification
slack: ConversationsSetTopicResponse
Closed record
Schema for successful response from conversations.setTopic method
Fields
- channel ConversationObj -
- ok OkTrueDef -
slack: ConversationsUnarchiveBody
Fields
- channel? string - ID of conversation to unarchive
slack: ConversationsUnarchiveResponse
Closed record
Schema for successful response from conversations.unarchive method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse1
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse10
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse11
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse12
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse13
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse14
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse15
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse16
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse17
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse18
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse19
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse2
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse20
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse21
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse22
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse23
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse24
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse25
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse26
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse27
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse28
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse29
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse3
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse30
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse31
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse32
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse33
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse34
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse35
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse36
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse37
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse38
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse39
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse4
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse40
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse41
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse42
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse43
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse44
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse45
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse46
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse47
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse48
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse49
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse5
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse50
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse51
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse52
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse53
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse54
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse55
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse56
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse57
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse58
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse59
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse6
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse60
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse61
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse62
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse63
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse64
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse65
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse66
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse67
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse68
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse69
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse7
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse70
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse71
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse72
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse8
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DefaultSuccessResponse9
This method either only returns a brief OK response or a verbose schema is not available for this method
Fields
- ok OkTrueDef -
slack: DeprecationWarning
Closed record
Fields
- warnings ("method_deprecated")[] -
- messages string[] -
slack: DeprecationWarningAndPagingStyleTogether
Closed record
Fields
- nextCursor string -
- warnings ("method_deprecated")[] -
- messages string[] -
slack: DialogOpenQueries
Represents the Queries record for the operation: dialog_open
Fields
- dialog string - The dialog definition. This must be a JSON-encoded string
- triggerId string - Exchange a trigger to post to the user
slack: DialogOpenResponse
Closed record
Schema for successful response from dialog.open method
Fields
- ok OkTrueDef -
slack: DndEndDndResponse
Closed record
Schema for successful response from dnd.endDnd method
Fields
- ok OkTrueDef -
slack: DndEndSnoozeResponse
Closed record
Schema for successful response from dnd.endSnooze method
Fields
- nextDndEndTs int -
- dndEnabled boolean -
- nextDndStartTs int -
- snoozeEnabled boolean -
- ok OkTrueDef -
slack: DndInfoQueries
Represents the Queries record for the operation: dnd_info
Fields
- user? string - User to fetch status for (defaults to current user)
slack: DndInfoResponse
Closed record
Schema for successful response from dnd.info method
Fields
- nextDndEndTs int -
- snoozeEndtime? int -
- dndEnabled boolean -
- nextDndStartTs int -
- snoozeEnabled? boolean -
- snoozeRemaining? int -
- ok OkTrueDef -
slack: DndSetSnoozeBody
Fields
- numMinutes string - Number of minutes, from now, to snooze until
- token string - Authentication token. Requires scope:
dnd:write
slack: DndSetSnoozeResponse
Closed record
Schema for successful response from dnd.setSnooze method
Fields
- snoozeEndtime int -
- snoozeEnabled boolean -
- snoozeRemaining int -
- ok OkTrueDef -
slack: DndTeamInfoQueries
Represents the Queries record for the operation: dnd_teamInfo
Fields
- users? string - Comma-separated list of users to fetch Do Not Disturb status for
slack: EnterpriseUserObj
Closed record
Fields
- isAdmin boolean -
- teams TeamDef[] -
- isOwner boolean -
- id EnterpriseUserIdDef -
- enterpriseId EnterpriseIdDef -
- enterpriseName EnterpriseNameDef -
slack: ExternalOrgMigrationsObj
Fields
- current ExternalOrgMigrationsObjCurrent[] -
- dateUpdated int -
slack: ExternalOrgMigrationsObjCurrent
Fields
- teamId string -
- dateStarted int -
slack: FileObj
Closed record
Fields
- filetype? string -
- thumb360? string -
- thumb160? string -
- dateDelete? int -
- thumb480? string -
- pinnedInfo? PinnedInfoDef -
- thumb800? string -
- thumb720? string -
- nonOwnerEditable? boolean -
- thumb960? string -
- thumb800W? int -
- mode? string -
- externalUrl? string -
- isTombstoned? boolean -
- numStars? int -
- imageExifRotation? int -
- id? FileIdDef -
- state? string -
- thumb64? string -
- created? int -
- lastEditor? UserIdDef -
- thumb480W? int -
- thumb960H? int -
- urlPrivateDownload? string -
- permalinkPublic? string -
- hasRichPreview? boolean -
- isStarred? boolean -
- channels? ChannelIdDef[] -
- size? int -
- commentsCount? int -
- name? string -
- permalink? string -
- updated? int -
- originalW? int -
- thumb480H? int -
- thumb720W? int -
- preview? string -
- externalId? string -
- thumb1024H? int -
- title? string -
- originalH? int -
- ims? DmIdDef[] -
- thumb720H? int -
- urlPrivate? string -
- thumb960W? int -
- displayAsBot? boolean -
- timestamp? int -
- editor? UserIdDef -
- thumb80? string -
- editable? boolean -
- groups? GroupIdDef[] -
- isExternal? boolean -
- thumb360H? int -
- prettyType? string -
- externalType? string -
- userTeam? TeamDef -
- pinnedTo? ChannelDef[] -
- thumb800H? int -
- sourceTeam? TeamDef -
- isPublic? boolean -
- thumb360W? int -
- thumbTiny? string -
- mimetype? string -
- reactions? ReactionObj[] -
- thumb1024W? int -
- thumb1024? string -
- user? string -
- username? string -
slack: FileObjShares
Closed record
Fields
- 'private? record {||} -
- 'public? record {||} -
slack: FilePin
Closed record
Fields
- file? FileObj -
- created? int -
- 'type? "file" -
- createdBy? UserIdDef -
slack: FilesCommentsDeleteBody
Fields
- file? string - File to delete a comment from
- id? string - The comment to delete
slack: FilesCommentsDeleteResponse
Closed record
Schema for successful response files.comments.delete method
Fields
- ok OkTrueDef -
slack: FilesDeleteBody
Fields
- file? string - ID of file to delete
slack: FilesDeleteResponse
Closed record
Schema for successful response files.delete method
Fields
- ok OkTrueDef -
slack: FilesInfoQueries
Represents the Queries record for the operation: files_info
Fields
- cursor? string - Parameter for pagination. File comments are paginated for a single file. Set
cursorequal to thenext_cursorattribute returned by the previous request'sresponse_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection of comments. See pagination for more details
- file? string - Specify a file by providing its ID
- count? string -
- 'limit? int - The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached
- page? string -
slack: FilesInfoResponse
Closed record
Schema for successful response from files.info method
Fields
- editor? UserIdDef -
- comments CommentsObj -
- file FileObj -
- paging? PagingObj -
- responseMetadata? ResponseMetadataObj -
- ok OkTrueDef -
- contentHtml? anydata? -
slack: FilesListQueries
Represents the Queries record for the operation: files_list
Fields
- tsFrom? decimal - Filter files created after this timestamp (inclusive)
- showFilesHiddenByLimit? boolean - Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit
- tsTo? decimal - Filter files created before this timestamp (inclusive)
- channel? string - Filter files appearing in a specific channel, indicated by its ID
- count? string -
- page? string -
- user? string - Filter files created by a single user
slack: FilesListResponse
Closed record
Schema for successful response from files.list method
Fields
- files FileObj[] -
- paging PagingObj -
- ok OkTrueDef -
slack: FilesRemoteAddBody
Fields
- filetype? string - type of file
- externalUrl? string - URL of the remote file
- previewImage? string - Preview of the document via
multipart/form-data
- externalId? string - Creator defined GUID for the file
- indexableFileContents? string - A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file
- title? string - Title of the file being shared
- token? string - Authentication token. Requires scope:
remote_files:write
slack: FilesRemoteInfoQueries
Represents the Queries record for the operation: files_remote_info
Fields
- file? string - Specify a file by providing its ID
- externalId? string - Creator defined GUID for the file
slack: FilesRemoteListQueries
Represents the Queries record for the operation: files_remote_list
Fields
- tsFrom? decimal - Filter files created after this timestamp (inclusive)
- cursor? string - Paginate through collections of data by setting the
cursorparameter to anext_cursorattribute returned by a previous request'sresponse_metadata. Default value fetches the first "page" of the collection. See pagination for more detail
- tsTo? decimal - Filter files created before this timestamp (inclusive)
- channel? string - Filter files appearing in a specific channel, indicated by its ID
- 'limit? int - The maximum number of items to return
slack: FilesRemoteRemoveBody
Fields
- file? string - Specify a file by providing its ID
- externalId? string - Creator defined GUID for the file
- token? string - Authentication token. Requires scope:
remote_files:write
slack: FilesRemoteShareQueries
Represents the Queries record for the operation: files_remote_share
Fields
- file? string - Specify a file registered with Slack by providing its ID. Either this field or
external_idor both are required
- channels? string - Comma-separated list of channel IDs where the file will be shared
- externalId? string - The globally unique identifier (GUID) for the file, as set by the app registering the file with Slack. Either this field or
fileor both are required
slack: FilesRemoteUpdateBody
Fields
- filetype? string - type of file
- externalUrl? string - URL of the remote file
- file? string - Specify a file by providing its ID
- previewImage? string - Preview of the document via
multipart/form-data
- externalId? string - Creator defined GUID for the file
- indexableFileContents? string - File containing contents that can be used to improve searchability for the remote file
- title? string - Title of the file being shared
- token? string - Authentication token. Requires scope:
remote_files:write
slack: FilesRevokePublicURLBody
Fields
- file? string - File to revoke
slack: FilesRevokePublicURLResponse
Closed record
Schema for successful response from files.revokePublicURL method
Fields
- file FileObj -
- ok OkTrueDef -
slack: FilesSharedPublicURLBody
Fields
- file? string - File to share
slack: FilesSharedPublicURLResponse
Closed record
Schema for successful response from files.sharedPublicURL method
Fields
- file FileObj -
- ok OkTrueDef -
slack: FilesUploadBody
Fields
- file? string - File contents via
multipart/form-data. If omitting this parameter, you must submitcontent
- filename? string - Filename of file
- channels? string - Comma-separated list of channel names or IDs where the file will be shared
- threadTs? decimal - Provide another message's
tsvalue to upload this file as a reply. Never use a reply'stsvalue; use its parent instead
- initialComment? string - The message text introducing the file in specified
channels
- title? string - Title of file
- content? string - File contents via a POST variable. If omitting this parameter, you must provide a
file
- token? string - Authentication token. Requires scope:
files:write:user
slack: FilesUploadResponse
Closed record
Schema for successful response files.upload method
Fields
- file FileObj -
- ok OkTrueDef -
slack: IconObj
Fields
- image132? string -
- image102? string -
- image68? string -
- imageDefault? boolean -
- image34? string -
- image230? string -
- image44? string -
- image88? string -
slack: MessageObj
Closed record
Fields
- attachments? MessageObjAttachments[] -
- clientMsgId? string -
- purpose? string -
- upload? boolean -
- isIntro? boolean -
- userProfile? UserProfileShortObj -
- 'type string -
- isDelayedMessage? boolean -
- subscribed? boolean -
- unreadCount? int -
- file? FileObj -
- subtype? string -
- replyUsersCount? int -
- inviter? UserIdDef -
- text string -
- displayAsBot? boolean -
- botId? MessageObjBotId[] -
- latestReply? TsDef -
- lastRead? TsDef -
- parentUserId? UserIdDef -
- blocks? Blocks - This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace
- replyUsers? UserIdDef[] -
- team? WorkspaceIdDef -
- icons? MessageObjIcons -
- replyCount? int -
- userTeam? WorkspaceIdDef -
- pinnedTo? ChannelDef[] -
- isStarred? boolean -
- botProfile? BotProfileObj -
- oldName? string -
- sourceTeam? WorkspaceIdDef -
- threadTs? TsDef -
- name? string -
- files? FileObj[] -
- topic? string -
- comment? CommentObj -
- reactions? ReactionObj[] -
- permalink? string -
- user? UserIdDef -
- ts TsDef -
- username? string -
slack: MessageObjAttachments
Closed record
Fields
- imageHeight? int -
- imageUrl? string -
- id int -
- imageWidth? int -
- fallback? string -
- imageBytes? int -
slack: MessageObject
Fields
- attachments? record {}[] -
- blocks? record {} -
- text string -
slack: MessageObjIcons
Closed record
Fields
- image64? string -
- emoji? string -
slack: MessagePin
Closed record
Fields
- created? int -
- channel? ChannelDef -
- message? MessageObj -
- 'type? "message" -
- createdBy? UserIdDef -
slack: MigrationExchangeQueries
Represents the Queries record for the operation: migration_exchange
Fields
- toOld? boolean - Specify
trueto convertWglobal user IDs to workspace-specificUIDs. Defaults tofalse
- teamId? string - Specify team_id starts with
Tin case of Org Token
- users string - A comma-separated list of user ids, up to 400 per request
slack: MigrationExchangeResponse
Schema for successful response from migration.exchange method
Fields
- enterprise_id string -
- invalid_user_ids? string[] -
- ok OkTrueDef -
- team_id TeamDef -
- user_id_map? record {} -
slack: NewPagingStyle
Closed record
Fields
- nextCursor string -
slack: OAuth2RefreshTokenGrantConfig
Closed record
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://slack.com/api/oauth.access") - Refresh URL
slack: OauthAccessQueries
Represents the Queries record for the operation: oauth_access
Fields
- singleChannel? boolean - Request the user to add your app only to a single channel. Only valid with a legacy workspace app
- code? string - The
codeparam returned via the OAuth callback
- clientSecret? string - Issued when you created your application
- redirectUri? string - This must match the originally submitted URI (if one was sent)
- clientId? string - Issued when you created your application
slack: OauthTokenQueries
Represents the Queries record for the operation: oauth_token
Fields
- singleChannel? boolean - Request the user to add your app only to a single channel
- code? string - The
codeparam returned via the OAuth callback
- clientSecret? string - Issued when you created your application
- redirectUri? string - This must match the originally submitted URI (if one was sent)
- clientId? string - Issued when you created your application
slack: OauthV2AccessQueries
Represents the Queries record for the operation: oauth_v2_access
Fields
- code string - The
codeparam returned via the OAuth callback
- clientSecret? string - Issued when you created your application
- redirectUri? string - This must match the originally submitted URI (if one was sent)
- clientId? string - Issued when you created your application
slack: PagingObj
Closed record
Fields
- perPage? int -
- total int -
- pages? int -
- spill? int -
- count? int -
- page int -
slack: PinnedInfoDef
Closed record
slack: PinsAddBody
Fields
- channel string - Channel to pin the item in
- timestamp? string - Timestamp of the message to pin
slack: PinsAddResponse
Closed record
Schema for successful response from pins.add method
Fields
- ok OkTrueDef -
slack: PinsListQueries
Represents the Queries record for the operation: pins_list
Fields
- channel string - Channel to get pinned items for
slack: PinsRemoveBody
Fields
- channel string - Channel where the item is pinned to
- timestamp? string - Timestamp of the message to un-pin
slack: PinsRemoveResponse
Closed record
Schema for successful response from pins.remove method
Fields
- ok OkTrueDef -
slack: PrimaryOwnerObj
Fields
- id string -
- email string -
slack: ReactionObj
Fields
- count int -
- name string -
- users UserIdDef[] -
slack: ReactionsAddBody
Fields
- channel string - Channel where the message to add reaction to was posted
- name string - Reaction (emoji) name
- timestamp string - Timestamp of the message to add reaction to
slack: ReactionsAddResponse
Closed record
Schema for successful response from reactions.add method
Fields
- ok OkTrueDef -
slack: ReactionsGetQueries
Represents the Queries record for the operation: reactions_get
Fields
- file? string - File to get reactions for
- channel? string - Channel where the message to get reactions for was posted
- fileComment? string - File comment to get reactions for
- full? boolean - If true always return the complete reaction list
- timestamp? string - Timestamp of the message to get reactions for
slack: ReactionsListQueries
Represents the Queries record for the operation: reactions_list
Fields
- cursor? string - Parameter for pagination. Set
cursorequal to thenext_cursorattribute returned by the previous request'sresponse_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details
- count? int -
- 'limit? int - The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached
- page? int -
- user? string - Show reactions made by this user. Defaults to the authed user
- full? boolean - If true always return the complete reaction list
slack: ReactionsListResponse
Closed record
Schema for successful response from reactions.list method
Fields
- paging? PagingObj -
- responseMetadata? ResponseMetadataObj -
- ok OkTrueDef -
- items (record {| channel ChannelDef, message MessageObj, 'type "message" |}|record {| file FileObj, 'type "file" |}|record {| comment CommentObj, file FileObj, 'type "file_comment" |})[][] -
slack: ReactionsRemoveBody
Fields
- file? string - File to remove reaction from
- channel? string - Channel where the message to remove reaction from was posted
- name string - Reaction (emoji) name
- fileComment? string - File comment to remove reaction from
- timestamp? string - Timestamp of the message to remove reaction from
slack: ReactionsRemoveResponse
Closed record
Schema for successful response from reactions.remove method
Fields
- ok OkTrueDef -
slack: ReminderObj
Closed record
Fields
- creator UserIdDef -
- recurring boolean -
- completeTs? int -
- id ReminderIdDef -
- text string -
- time? int -
- user UserIdDef -
slack: RemindersAddBody
Fields
- text string - The content of the reminder
- time string - When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday")
- user? string - The user who will receive the reminder. If no user is specified, the reminder will go to user who created it
slack: RemindersAddResponse
Closed record
Schema for successful response from reminders.add method
Fields
- reminder ReminderObj -
- ok OkTrueDef -
slack: RemindersCompleteBody
Fields
- reminder? string - The ID of the reminder to be marked as complete
slack: RemindersCompleteResponse
Closed record
Schema for successful response from reminders.complete method
Fields
- ok OkTrueDef -
slack: RemindersDeleteBody
Fields
- reminder? string - The ID of the reminder
slack: RemindersDeleteResponse
Closed record
Schema for successful response from reminders.delete method
Fields
- ok OkTrueDef -
slack: RemindersInfoQueries
Represents the Queries record for the operation: reminders_info
Fields
- reminder? string - The ID of the reminder
slack: RemindersInfoResponse
Closed record
Schema for successful response from reminders.info method
Fields
- reminder ReminderObj -
- ok OkTrueDef -
slack: RemindersListResponse
Closed record
Schema for successful response from reminders.list method
Fields
- reminders ReminderObj[] -
- ok OkTrueDef -
slack: ResourcesObj
Closed record
Fields
- ids (ChannelDef|TeamDef)[][] -
- excludedIds? (ChannelDef|TeamDef)[][] -
- wildcard? boolean -
slack: ResponseMetadata
Fields
- warnings? string[] -
slack: RtmConnectQueries
Represents the Queries record for the operation: rtm_connect
Fields
- batchPresenceAware? boolean - Batch presence deliveries via subscription. Enabling changes the shape of
presence_changeevents. See batch presence
- presenceSub? boolean - Only deliver presence events when requested by subscription. See presence subscriptions
slack: RtmConnectResponse
Closed record
Schema for successful response from rtm.connect method
Fields
- self RtmConnectResponseSelf -
- team RtmConnectResponseTeam -
- ok OkTrueDef -
- url string -
slack: RtmConnectResponseSelf
Closed record
Fields
- name string -
- id UserIdDef -
slack: RtmConnectResponseTeam
Closed record
Fields
- domain string -
- name string -
- id TeamDef -
slack: SearchMessagesQueries
Represents the Queries record for the operation: search_messages
Fields
- highlight? boolean - Pass a value of
trueto enable query highlight markers (see below)
- query string - Search query
- count? int - Pass the number of results you want per "page". Maximum of
100
- page? int -
- sort? string - Return matches sorted by either
scoreortimestamp
- sortDir? string - Change sort direction to ascending (
asc) or descending (desc)
slack: StarsAddBody
Fields
- file? string - File to add star to
- channel? string - Channel to add star to, or channel where the message to add star to was posted (used with
timestamp)
- fileComment? string - File comment to add star to
- timestamp? string - Timestamp of the message to add star to
slack: StarsAddResponse
Closed record
Schema for successful response from stars.add method
Fields
- ok OkTrueDef -
slack: StarsListQueries
Represents the Queries record for the operation: stars_list
Fields
- cursor? string - Parameter for pagination. Set
cursorequal to thenext_cursorattribute returned by the previous request'sresponse_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details
- count? string -
- 'limit? int - The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached
- page? string -
slack: StarsListResponse
Closed record
Schema for successful response from stars.list method
Fields
- paging? PagingObj -
- ok OkTrueDef -
- items (record {| channel ChannelDef, date_create int, message MessageObj, 'type "message" |}|record {| date_create int, file FileObj, 'type "file" |}|record {| comment CommentObj, date_create int, file FileObj, 'type "file_comment" |}|record {| channel ChannelDef, date_create int, 'type "channel" |}|record {| channel DmIdDef, date_create int, 'type "im" |}|record {| channel GroupIdDef, date_create int, 'type "group" |})[][] -
slack: StarsRemoveBody
Fields
- file? string - File to remove star from
- channel? string - Channel to remove star from, or channel where the message to remove star from was posted (used with
timestamp)
- fileComment? string - File comment to remove star from
- timestamp? string - Timestamp of the message to remove star from
slack: StarsRemoveResponse
Closed record
Schema for successful response from stars.remove method
Fields
- ok OkTrueDef -
slack: SubteamObj
Closed record
Fields
- channelCount? int -
- dateDelete int -
- dateUpdate int -
- deletedBy SubteamObjDeletedBy[] -
- description string -
- isExternal boolean -
- 'handle string -
- teamId TeamDef -
- createdBy UserIdDef -
- users? UserIdDef[] -
- autoType SubteamObjAutoType[] -
- prefs SubteamObjPrefs -
- isSubteam boolean -
- userCount? int -
- dateCreate int -
- name string -
- updatedBy UserIdDef -
- isUsergroup boolean -
- id SubteamIdDef -
- autoProvision boolean -
- enterpriseSubteamId string -
slack: SubteamObjPrefs
Closed record
Fields
- channels ChannelIdDef[] -
- groups GroupIdDef[] -
slack: TeamAccessLogsQueries
Represents the Queries record for the operation: team_accessLogs
Fields
- before? string - End of time range of logs to include in results (inclusive)
- count? string -
- page? string -
slack: TeamAccessLogsResponse
Closed record
Schema for successful response from team.accessLogs method
Fields
- paging PagingObj -
- ok OkTrueDef -
- logins TeamAccessLogsResponseLogins[] -
slack: TeamAccessLogsResponseLogins
Closed record
Fields
- country string? -
- dateLast int -
- userId UserIdDef -
- ip string? -
- isp string? -
- count int -
- dateFirst int -
- region string? -
- userAgent string -
- username string -
slack: TeamBillableInfoQueries
Represents the Queries record for the operation: team_billableInfo
Fields
- user? string - A user to retrieve the billable information for. Defaults to all users
slack: TeamInfoQueries
Represents the Queries record for the operation: team_info
Fields
- team? string - Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels
slack: TeamInfoResponse
Closed record
Schema for successful response from team.info method
Fields
- team TeamObj -
- ok OkTrueDef -
slack: TeamIntegrationLogsQueries
Represents the Queries record for the operation: team_integrationLogs
Fields
- serviceId? string - Filter logs to this service. Defaults to all logs
- count? string -
- changeType? string - Filter logs with this change type. Defaults to all logs
- page? string -
- appId? string - Filter logs to this Slack app. Defaults to all logs
- user? string - Filter logs generated by this user’s actions. Defaults to all logs
slack: TeamIntegrationLogsResponse
Closed record
Schema for successful response from team.integrationLogs method
Fields
- paging PagingObj -
- ok OkTrueDef -
- logs TeamIntegrationLogsResponseLogs[] -
slack: TeamIntegrationLogsResponseLogs
Closed record
Fields
- date string -
- serviceType? string -
- appType string -
- userId UserIdDef -
- userName string -
- scope string -
- serviceId? string -
- channel? ChannelDef -
- changeType string -
- adminAppId? AppIdDef -
- appId AppIdDef -
slack: TeamObj
Closed record
Fields
- primaryOwner? PrimaryOwnerObj -
- isEnterprise? int -
- icon IconObj -
- description? string? -
- msgEditWindowMins? int -
- avatarBaseUrl? string -
- ssoProvider? TeamObjSsoProvider -
- locale? string -
- archived? boolean -
- messagesCount? int -
- payProdCur? string -
- id WorkspaceIdDef -
- isOverStorageLimit? boolean -
- plan? ""|"std"|"plus"|"compliance"|"enterprise" -
- externalOrgMigrations? ExternalOrgMigrationsObj -
- overIntegrationsLimit? boolean -
- created? int -
- isAssigned? boolean -
- limitTs? int -
- enterpriseId? EnterpriseIdDef -
- deleted? boolean -
- hasComplianceExport? boolean -
- dateCreate? int -
- discoverable? TeamObjDiscoverable[] -
- domain string -
- name string -
- emailDomain string -
- enterpriseName? EnterpriseNameDef -
- overStorageLimit? boolean -
slack: TeamObjSsoProvider
Fields
- name? string -
- label? string -
- 'type? string -
slack: TeamProfileFieldObj
Closed record
Fields
- ordering decimal -
- hint string -
- possibleValues? string[]? -
- isHidden? boolean -
- options? TeamProfileFieldObjOptions[] -
- id string -
- label string -
- 'type "text"|"date"|"link"|"mailto"|"options_list"|"user" -
- fieldName? string? -
slack: TeamProfileFieldOptionObj
Closed record
Fields
- isScim? boolean? -
- isCustom? boolean? -
- isProtected? boolean? -
- isMultipleEntry? boolean? -
slack: TeamProfileGetQueries
Represents the Queries record for the operation: team_profile_get
Fields
- visibility? string - Filter by visibility
slack: TeamProfileGetResponse
Closed record
Schema for successful response from team.profile.get method
Fields
- profile TeamProfileGetResponseProfile -
- ok OkTrueDef -
slack: TeamProfileGetResponseProfile
Closed record
Fields
- fields TeamProfileFieldObj[] -
slack: UsergroupsCreateBody
Fields
- channels? string - A comma separated string of encoded channel IDs for which the User Group uses as a default
- name string - A name for the User Group. Must be unique among User Groups
- description? string - A short description of the User Group
- 'handle? string - A mention handle. Must be unique among channels, users and User Groups
- includeCount? boolean - Include the number of users in each User Group
slack: UsergroupsCreateResponse
Closed record
Schema for successful response from usergroups.create method
Fields
- usergroup SubteamObj -
- ok OkTrueDef -
slack: UsergroupsDisableBody
Fields
- usergroup string - The encoded ID of the User Group to disable
- includeCount? boolean - Include the number of users in the User Group
slack: UsergroupsDisableResponse
Closed record
Schema for successful response from usergroups.disable method
Fields
- usergroup SubteamObj -
- ok OkTrueDef -
slack: UsergroupsEnableBody
Fields
- usergroup string - The encoded ID of the User Group to enable
- includeCount? boolean - Include the number of users in the User Group
slack: UsergroupsEnableResponse
Closed record
Schema for successful response from usergroups.enable method
Fields
- usergroup SubteamObj -
- ok OkTrueDef -
slack: UsergroupsListQueries
Represents the Queries record for the operation: usergroups_list
Fields
- includeDisabled? boolean - Include disabled User Groups
- includeUsers? boolean - Include the list of users for each User Group
- includeCount? boolean - Include the number of users in each User Group
slack: UsergroupsListResponse
Closed record
Schema for successful response from usergroups.list method
Fields
- usergroups SubteamObj[] -
- ok OkTrueDef -
slack: UsergroupsUpdateBody
Fields
- channels? string - A comma separated string of encoded channel IDs for which the User Group uses as a default
- name? string - A name for the User Group. Must be unique among User Groups
- usergroup string - The encoded ID of the User Group to update
- description? string - A short description of the User Group
- 'handle? string - A mention handle. Must be unique among channels, users and User Groups
- includeCount? boolean - Include the number of users in the User Group
slack: UsergroupsUpdateResponse
Closed record
Schema for successful response from usergroups.update method
Fields
- usergroup SubteamObj -
- ok OkTrueDef -
slack: UsergroupsUsersListQueries
Represents the Queries record for the operation: usergroups_users_list
Fields
- includeDisabled? boolean - Allow results that involve disabled User Groups
- usergroup string - The encoded ID of the User Group to update
slack: UsergroupsUsersListResponse
Closed record
Schema for successful response from usergroups.users.list method
Fields
- ok OkTrueDef -
- users UserIdDef[] -
slack: UsergroupsUsersUpdateBody
Fields
- usergroup string - The encoded ID of the User Group to update
- includeCount? boolean - Include the number of users in the User Group
- users string - A comma separated string of encoded user IDs that represent the entire list of users for the User Group
slack: UsergroupsUsersUpdateResponse
Closed record
Schema for successful response from usergroups.users.update method
Fields
- usergroup SubteamObj -
- ok OkTrueDef -
slack: UserObjAnyOf1
Closed record
user object for non enterprise type
Fields
- color? string -
- isInvitedUser? boolean -
- has2fa? boolean -
- isRestricted? boolean -
- tz? UserObjTz[] -
- tzLabel? string -
- isPrimaryOwner? boolean -
- teamProfile? UserObjTeamProfile -
- realName? string -
- teamId? WorkspaceIdDef -
- locale? string -
- isAdmin? boolean -
- isAppUser boolean -
- tzOffset? decimal -
- isStranger? boolean -
- isForgotten? boolean -
- id UserIdDef -
- isBot boolean -
- presence? string -
- isUltraRestricted? boolean -
- isOwner? boolean -
- profile UserProfileObj -
- isExternal? boolean -
- team? WorkspaceIdDef -
- enterpriseUser? EnterpriseUserObj -
- deleted? boolean -
- twoFactorType? string -
- name string -
- updated decimal -
slack: UserObjTeamProfile
Closed record
Fields
- fields TeamProfileFieldObj[] -
slack: UserObjTeamProfile1
Closed record
Fields
- fields TeamProfileFieldObj[] -
slack: UserObjUserObjAnyOf12
Closed record
enterprise user
Fields
- color? string - refercing to bug: https://jira.tinyspeck.com/browse/EVALUE-1559
- has2fa? boolean -
- isRestricted? boolean -
- tz? UserObjTz1[] -
- tzLabel? string -
- isPrimaryOwner? boolean -
- teamProfile? UserObjTeamProfile1 -
- realName? string -
- teamId? WorkspaceIdDef -
- locale? string -
- isAdmin? boolean -
- isAppUser boolean -
- tzOffset? decimal -
- isStranger? boolean -
- isForgotten? boolean -
- id UserIdDef -
- isBot boolean -
- presence? string -
- isUltraRestricted? boolean -
- teams? WorkspaceIdDef[] -
- isOwner? boolean -
- profile UserProfileObj -
- isExternal? boolean -
- enterpriseUser? EnterpriseUserObj -
- deleted? boolean -
- twoFactorType? string -
- name string -
- updated decimal -
slack: UserProfileObj
Closed record
Fields
- image32? string? -
- statusEmoji string -
- guestInvitedBy? string? -
- isRestricted? boolean? -
- apiAppId? OptionalAppIdDef -
- image192? string? -
- realName string -
- title string -
- statusTextCanonical? string? -
- skype string -
- isAppUser? boolean -
- imageOriginal? string? -
- guestExpirationTs? int? -
- realNameNormalized string -
- avatarHash string -
- firstName? string? -
- botId? BotIdDef -
- email? string? -
- image512? string? -
- statusDefaultTextCanonical? string? -
- isUltraRestricted? boolean? -
- image1024? string? -
- statusDefaultEmoji? string -
- image24? string? -
- lastName? string? -
- image48? string? -
- team? WorkspaceIdDef -
- displayName string -
- lastAvatarImageHash? string -
- alwaysActive? boolean -
- statusExpiration? int -
- membershipsCount? int -
- phone string -
- userId? string -
- name? string? -
- statusDefaultText? string -
- pronouns? string -
- isCustomImage? boolean -
- statusText string -
- fields record {}[]? -
- image72? string? -
- updated? int -
- displayNameNormalized string -
- username? string? -
slack: UserProfileShortObj
Closed record
Fields
- isUltraRestricted boolean -
- isRestricted boolean -
- realNameNormalized? string -
- name string -
- realName string -
- team WorkspaceIdDef -
- avatarHash string -
- displayName string -
- image72 string -
- firstName string? -
- displayNameNormalized? string -
slack: UsersConversationsQueries
Represents the Queries record for the operation: users_conversations
Fields
- cursor? string - Paginate through collections of data by setting the
cursorparameter to anext_cursorattribute returned by a previous request'sresponse_metadata. Default value fetches the first "page" of the collection. See pagination for more detail
- types? string - Mix and match channel types by providing a comma-separated list of any combination of
public_channel,private_channel,mpim,im
- 'limit? int - The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000
- user? string - Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership
- excludeArchived? boolean - Set to
trueto exclude archived channels from the list
slack: UsersConversationsResponse
Schema for successful response from users.conversations method. Returned conversation objects do not include num_members or is_member
Fields
- channels ConversationObj[] -
- ok OkTrueDef -
- response_metadata? UsersConversationsResponseResponseMetadata -
slack: UsersConversationsResponseResponseMetadata
Closed record
Fields
- nextCursor string -
slack: UsersDeletePhotoBody
Fields
- token string - Authentication token. Requires scope:
users.profile:write
slack: UsersDeletePhotoResponse
Closed record
Schema for successful response from users.deletePhoto method
Fields
- ok OkTrueDef -
slack: UsersGetPresenceQueries
Represents the Queries record for the operation: users_getPresence
Fields
- user? string - User to get presence info on. Defaults to the authed user
slack: UsersInfoQueries
Represents the Queries record for the operation: users_info
Fields
- includeLocale? boolean - Set this to
trueto receive the locale for this user. Defaults tofalse
- user? string - User to get info on
slack: UsersInfoResponse
Schema for successful response from users.info method
Fields
- ok OkTrueDef -
- user UserObj -
slack: UsersListQueries
Represents the Queries record for the operation: users_list
Fields
- cursor? string - Paginate through collections of data by setting the
cursorparameter to anext_cursorattribute returned by a previous request'sresponse_metadata. Default value fetches the first "page" of the collection. See pagination for more detail
- 'limit? int - The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no
limitvalue will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experiencelimit_requiredor HTTP 500 errors
- includeLocale? boolean - Set this to
trueto receive the locale for users. Defaults tofalse
slack: UsersListResponse
Closed record
Schema for successful response from users.list method
Fields
- cacheTs int -
- members UserObj[] -
- responseMetadata? ResponseMetadataObj -
- ok OkTrueDef -
slack: UsersLookupByEmailQueries
Represents the Queries record for the operation: users_lookupByEmail
Fields
- email string - An email address belonging to a user in the workspace
slack: UsersLookupByEmailResponse
Schema for successful response from users.lookupByEmail method
Fields
- ok OkTrueDef -
- user UserObj -
slack: UsersProfileGetQueries
Represents the Queries record for the operation: users_profile_get
Fields
- includeLabels? boolean - Include labels for each ID in custom profile fields
- user? string - User to retrieve profile info for
slack: UsersProfileGetResponse
Closed record
Schema for successful response from users.profile.get method
Fields
- profile UserProfileObj -
- ok OkTrueDef -
slack: UsersProfileSetBody
Fields
- profile? string - Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters
- name? string - Name of a single key to set. Usable only if
profileis not passed
- user? string - ID of user to change. This argument may only be specified by team admins on paid teams
- value? string - Value to set a single key to. Usable only if
profileis not passed
slack: UsersProfileSetResponse
Closed record
Schema for successful response from users.profile.set method
Fields
- profile UserProfileObj -
- ok OkTrueDef -
- emailPending? string -
- username string -
slack: UsersSetActiveResponse
Closed record
Schema for successful response from users.setActive method
Fields
- ok OkTrueDef -
slack: UsersSetPhotoBody
Fields
- cropY? string - Y coordinate of top-left corner of crop box
- image? string - File contents via
multipart/form-data
- cropW? string - Width/height of crop box (always square)
- cropX? string - X coordinate of top-left corner of crop box
- token string - Authentication token. Requires scope:
users.profile:write
slack: UsersSetPhotoResponse
Closed record
Schema for successful response from users.setPhoto method
Fields
- profile UsersSetPhotoResponseProfile -
- ok OkTrueDef -
slack: UsersSetPhotoResponseProfile
Closed record
Fields
- image32 string -
- imageOriginal string -
- image1024 string -
- image24 string -
- image192 string -
- image48 string -
- avatarHash string -
- image72 string -
- image512 string -
slack: UsersSetPresenceBody
Fields
- presence string - Either
autooraway
slack: UsersSetPresenceResponse
Closed record
Schema for successful response from users.setPresence method
Fields
- ok OkTrueDef -
slack: ViewsOpenQueries
Represents the Queries record for the operation: views_open
Fields
- view string - A view payload. This must be a JSON-encoded string
- triggerId string - Exchange a trigger to post to the user
slack: ViewsPublishQueries
Represents the Queries record for the operation: views_publish
Fields
- view string - A view payload. This must be a JSON-encoded string
- userId string -
idof the user you want publish a view to
- hash? string - A string that represents view state to protect against possible race conditions
slack: ViewsPushQueries
Represents the Queries record for the operation: views_push
Fields
- view string - A view payload. This must be a JSON-encoded string
- triggerId string - Exchange a trigger to post to the user
slack: ViewsUpdateQueries
Represents the Queries record for the operation: views_update
Fields
- view? string - A view object. This must be a JSON-encoded string
- viewId? string - A unique identifier of the view to be updated. Either
view_idorexternal_idis required
- externalId? string - A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either
view_idorexternal_idis required
- hash? string - A string that represents view state to protect against possible race conditions
slack: WorkflowsStepCompletedQueries
Represents the Queries record for the operation: workflows_stepCompleted
Fields
- workflowStepExecuteId string - Context identifier that maps to the correct workflow step execution
slack: WorkflowsStepFailedQueries
Represents the Queries record for the operation: workflows_stepFailed
Fields
- workflowStepExecuteId string - Context identifier that maps to the correct workflow step execution
- 'error string - A JSON-based object with a
messageproperty that should contain a human readable error message
slack: WorkflowsUpdateStepQueries
Represents the Queries record for the operation: workflows_updateStep
Fields
- outputs? string - An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed
- inputs? string - A JSON key-value map of inputs required from a user during configuration. This is the data your app expects to receive when the workflow step starts. Please note: the embedded variable format is set and replaced by the workflow system. You cannot create custom variables that will be replaced at runtime. Read more about variables in workflow steps here
- stepName? string - An optional field that can be used to override the step name that is shown in the Workflow Builder
- stepImageUrl? string - An optional field that can be used to override app image that is shown in the Workflow Builder
- workflowStepEditId string - A context identifier provided with
view_submissionpayloads used to call back toworkflows.updateStep
Union types
slack: ConversationsOpenResponseChannel
ConversationsOpenResponseChannel
slack: MessageObjBotId
MessageObjBotId
slack: ConversationObjParentConversation
ConversationObjParentConversation
slack: UserObjTz1
UserObjTz1
slack: ConversationObjParentConversation2
ConversationObjParentConversation2
slack: ConversationObjParentConversation1
ConversationObjParentConversation1
slack: ConversationObjLatest
ConversationObjLatest
slack: ConversationsHistoryResponseChannelActionsTs
ConversationsHistoryResponseChannelActionsTs
slack: SubteamObjDeletedBy
SubteamObjDeletedBy
slack: UserObjTz
UserObjTz
slack: ChannelObjLatest
ChannelObjLatest
slack: InlineResponseItems2002
InlineResponseItems2002
slack: InlineResponseItems2001
InlineResponseItems2001
slack: InlineArrayItemsConversationObj
InlineArrayItemsConversationObj
slack: AutoTypeAutoTypeAnyOf12
AutoTypeAutoTypeAnyOf12
slack: InlineResponseItems200
InlineResponseItems200
slack: SubteamObjAutoType
SubteamObjAutoType
slack: InlineArrayItemsUserObj
InlineArrayItemsUserObj
slack: ConversationObjLatest2
ConversationObjLatest2
slack: ConversationObjLatest1
ConversationObjLatest1
slack: TeamObjDiscoverable
TeamObjDiscoverable
slack: '200Items
'200Items
slack: TeamProfileFieldObjOptions
TeamProfileFieldObjOptions
slack: InlineArrayItemsResponseMetadataObj
InlineArrayItemsResponseMetadataObj
Array types
slack: ScopesObj
ScopesObj
slack: CommentsObj
CommentsObj
slack: ConversationObj
ConversationObj
slack: ResponseMetadataObj
ResponseMetadataObj
slack: Blocks
Blocks
This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace
slack: UserObj
UserObj
Anydata types
slack: TzAnyOf11
TzAnyOf11
slack: NilBotIdSetWhenDisplayAsBotIsFalse
NilBotIdSetWhenDisplayAsBotIsFalse
slack: ParentConversationAnyOf22
ParentConversationAnyOf22
slack: ParentConversationAnyOf21
ParentConversationAnyOf21
slack: ChannelActionsTsChannelActionsTsAnyOf12
ChannelActionsTsChannelActionsTsAnyOf12
slack: TzAnyOf1
TzAnyOf1
slack: OptionsAnyOf1
OptionsAnyOf1
slack: LatestAnyOf2
LatestAnyOf2
slack: DeletedByAnyOf1
DeletedByAnyOf1
slack: DiscoverableAnyOf1
DiscoverableAnyOf1
slack: LatestAnyOf23
LatestAnyOf23
slack: LatestAnyOf22
LatestAnyOf22
slack: LatestAnyOf21
LatestAnyOf21
slack: AutoTypeAnyOf1
AutoTypeAnyOf1
slack: ParentConversationAnyOf2
ParentConversationAnyOf2
String types
slack: DiscoverableDiscoverableAnyOf12
DiscoverableDiscoverableAnyOf12
slack: TzTzAnyOf112
TzTzAnyOf112
slack: TsDef
TsDef
slack: EnterpriseIdDef
EnterpriseIdDef
slack: EnterpriseNameDef
EnterpriseNameDef
slack: TeamDef
TeamDef
slack: ChannelNameDef
ChannelNameDef
slack: BotIdDef
BotIdDef
slack: UserIdDef
UserIdDef
slack: SubteamIdDef
SubteamIdDef
slack: TopicPurposeCreatorDef
TopicPurposeCreatorDef
slack: ReminderIdDef
ReminderIdDef
slack: CommentIdDef
CommentIdDef
slack: TzTzAnyOf12
TzTzAnyOf12
slack: ChannelIdDef
ChannelIdDef
slack: DmIdDef
DmIdDef
slack: FileIdDef
FileIdDef
slack: AppIdDef
AppIdDef
slack: EnterpriseUserIdDef
EnterpriseUserIdDef
slack: ChannelDef
ChannelDef
slack: OptionalAppIdDef
OptionalAppIdDef
slack: WorkspaceIdDef
WorkspaceIdDef
slack: GroupIdDef
GroupIdDef
Integer types
slack: ChannelActionsTsAnyOf1
ChannelActionsTsAnyOf1