The CData Sync App provides a straightforward way to continuously pipeline your Slack data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Slack connector can be used from the CData Sync application to pull data from Slack and move it to any of the supported destinations.
The Sync App leverages the Slack API to enable bidirectional access to Slack.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
The Sync App supports the following authentication mechanisms:
Use Token Authentication to authenticate to Slack with a non-expiring token. If you want the added security of tokens that expire and refresh, see the documentation for the "OAuth" authentication method in the next section.
To authenticate via Token Authentication, create an OAuth application and generate a non-expiring OAuth token, as described in Creating a Custom OAuth Application, then set the following connection properties:
Set AuthScheme to OAuth.
The following subsections describe how to authenticate to Slack via the available OAuth flows.
There are two supported OAuth authentication methods available. The setup process is the same for all OAuth methods (aside from the scopes set for custom apps), so configure the Sync App in accordance with the type of app you're using to authenticate.
Before you connect, set the following variables:
Click Connect to Slack to open the OAuth endpoint in your default browser. Log in and grant permissions to the application.
The driver then completes the OAuth process as follows:
These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.
This topic provides information about the required access scopes and endpoint domains for the Slack Sync App.
Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.
For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.
| Scope | Description |
| channels:read | View basic information about public channels in a workspace. Required for read and write access. |
| groups:read | View messages and other content in private channels that your Slack app has been added to. Required for read and write access. |
| im:read | View basic information about direct messages that your Slack app has been added to. Required for read and write access. |
| mpim:read | View basic information about group direct messages that your Slack app has been added to. Required for read and write access. |
| channels:history | View messages and other content in public channels that your Slack app has been added to. Required for read and write access. |
| groups:history | View messages and other content in private channels that your Slack app has been added to. Required for read and write access. |
| im:history | View messages and other content in direct messages that your Slack app has been added to. Required for read and write access. |
| mpim:history | View messages and other content in group direct messages that your Slack app has been added to. Required for read and write access. |
| search:read | Search a workspace’s content. Required for read and write access. |
| files:read | View files shared in channels and conversations that your Slack app has been added to. Required for read and write access. |
| pins:read | View pinned content in channels and conversations that your Slack app has been added to. Required for read and write access. |
| usergroups:read | View user groups in a workspace. Required for read and write access. |
| reminders:read | View reminders created by your Slack app. Required for read and write access. |
| users:read | View people in a workspace. Required for read and write access. |
| channels:write | Manage a user’s public channels and create new ones on a user’s behalf. Required for write access. |
| groups:write | Manage private channels that your Slack app has been added to and create new ones. Required for write access. |
| im:write | Start direct messages with people. Required for write access. |
| mpim:write | Start group direct messages with people. Required for write access. |
| chat:write:user | Send messages on a user’s behalf. Required for write access. |
| chat:write:bot | Send messages as your Slack app. Required for write access. |
| files:write:user | Upload, edit, and delete files as your Slack app. Required for write access. |
| pins:write | Add and remove pinned messages and files. Required for write access. |
| usergroups:write | Create and manage user groups. Required for write access. |
| reminders:write | Add, remove, or mark reminders as complete. Required for write access. |
| users.profile:write | Edit a user’s profile information and status. Required for write access. |
Endpoint domains are the specific URLs that the application needs to communicate with in order to authenticate, retrieve records, and perform other essential operations.
Allowlisting these domains ensures that the network traffic between your application and the API is not blocked by firewalls or security settings.
Note: Most users do not need to make any special configurations. Allowlisting is typically only necessary for environments with strict security measures, such as restricted outbound network traffic.
| Domain | Always Required | Description |
| slack.com | TRUE | The URL of the Slack API. |
This section details a selection of advanced features of the Slack Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The Sync App models the Slack APIs as Tables, Views and Stored Procedures.
The stored procedures are function-like interfaces to Slack that enable you to work with other aspects of the Slack API. They can be used to search, update, and modify information in Slack.
The tables, views and stored procedures are defined in static schema files, making them easy to customize.
The Sync App models the data in Slack as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Bookmarks | Retrieves the list of bookmarks for the channel. |
| Calls | Register, update, or return information about a Call. |
| Channels | Create, update, and query the available channels in Slack. |
| ConversationMembers | Retrieve members of a conversation. |
| Files | Query and delete team files. |
| MessageReplies | Create, update, delete, and query threads of messages posted to a conversation. |
| Messages | Create, update, delete, and query the available messages in Slack. |
| Pins | Create, delete, and query all items pinned to a channel. |
| Reactions | Create, delete, and query reactions on items. |
| Reminders | Create, delete, and query all reminders by or for a given user. |
| ScheduledMessages | Query all scheduled messages. |
| UserGroups | Create, update, and query all User Groups for a Slack team. |
| UserProfile | Retrieve a user's profile information, including their custom status. This table supports only Select and Update operations. |
| Users | Update and query all users for a Slack team. |
Retrieves the list of bookmarks for the channel.
You must specify the ChannelId column in the WHERE clause to query the Bookmarks table. The Sync App will use the Slack API to process search criteria that refer to the ChannelId columns. These columns support server-side processing for the = operator. The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server side by the Slack APIs:
SELECT * FROM Bookmarks WHERE ChannelId = 'C01KWCPJJ68'
ChannelId, Title, and Type are required for inserting a bookmark. Title, Type, Emoji, EntityId, Link, AccessLevel, and ParentId are the only columns that can be set on an insert.
INSERT INTO Bookmarks (ChannelId, Title, Type, Link) VALUES ('C01KWCPJJ68', 'Test Bookmark', 'link', 'https://app.slack.com/archives/C01KWCPJJ68/p1735804757564799')
INSERT INTO Bookmarks (ChannelId, Title, Type, Link, Emoji, AccessLevel) VALUES ('C01KWCPJJ68', 'Test Bookmark', 'link', 'https://app.slack.com/archives/C01KWCPJJ68/p1735804757564799', ':clap:', 'write')
The Bookmarks table allows updates for columns Title, Link, and Emoji when Id and ChannelId are specified.
UPDATE Bookmarks SET Link='https://cdatasoftware.slack.com/archives/C01KWCPJJ68/p1733740400267539' WHERE ChannelId = 'C01KWCPJJ68' and Id = 'Bk0871NJJQD8' Update Bookmarks SET Title='Test Bookmark Update' WHERE ChannelId = 'C01KWCPJJ68' and Id = 'Bk0871NJJQD8'
Bookmarks can be deleted by providing the ChannelId and the Id of the Bookmark.
DELETE FROM Bookmarks WHERE ChannelId = 'D71R6CSR1' AND Id = 'Bk0871NJJQD8'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The Id of the bookmark | |
| ChannelId | String | False |
The Id of the channel. | |
| AppId | String | False |
The App Id. | |
| DateCreated | Datetime | True |
The date when the bookmark was created. | |
| DateUpdated | Datetime | True |
The date when the bookmark was updated. | |
| Emoji | String | False |
The emoji tag added to the bookmark. | |
| EntityId | String | False |
The Id of the entity being bookmarked. | |
| IconUrl | String | True |
The URL of the icon. | |
| LastUpdatedByTeamId | String | True |
The Id of the team who last updated the bookmark. | |
| LastUpdatedByUserId | String | True |
The Id of the user who last updated the bookmark. | |
| Link | String | False |
Link to bookmark. | |
| Rank | String | False |
The rank of the bookmark. | |
| ShortcutId | String | True |
The shortcut Id. | |
| Title | String | False |
Title of the bookmark. | |
| Type | String | False |
Type of the bookmark. Supported values are 'link'. |
Pseudo column fields are used in the WHERE clause of SELECT statements. These offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| AccessLevel | String |
The level that we are setting the file's permission to (read or write). |
| ParentId | String |
Id of the bookmark's parent. |
| QuipSectionId | String |
Quip section ID to unbookmark. |
Register, update, or return information about a Call.
You must specify the Id column in the WHERE clause to query the Calls table.
The Sync App will use the Slack API to process search criteria that refer to the Id column. This column supports server-side processing for the = operator. The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Calls WHERE Id = 'R04HH525YBS'
Inserts are allowed when you specify the ExternalUniqueId and JoinURL. For example:
INSERT INTO Calls (ExternalUniqueId, JoinURL) VALUES (uniqId, joinurl)
Updates are allowed when you specify the Id.
UPDATE Calls SET JoinURL = 'join', Title = 't' WHERE Id = 'R04HH525YBS'
Slack does not allow Calls to be deleted.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Id of the call. | |
| DateStart | Datetime | True |
Start time of the call. | |
| DesktopAppJoinURL | String | False |
The desktop app join url of the call. | |
| ExternalDisplayId | String | False |
The external display of the call. | |
| ExternalUniqueId | String | False |
The external unique Id of the call. | |
| JoinURL | String | False |
The joining url of the call. | |
| Title | String | False |
The title of the call. | |
| Users | String | True |
The users involved in the call. |
Create, update, and query the available channels in Slack.
The Sync App uses the Slack API to process search criteria that refer to the Id, IsArchived, IsPublic, IsPrivate, IsDirectMessage, IsMultipartyDirectMessage and User columns. These columns support server-side processing for the = operator. The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server side by the Slack APIs:
SELECT * FROM Channels WHERE IsPublic = false AND IsArchived = true SELECT * FROM Channels WHERE Id = 'D71R6CSR1' SELECT * FROM Channels WHERE User = 'U03AZBU3CMT'
The Name column is the minimum requirement for an insert. Name and IsPublic are the only columns that can be set on an insert.
INSERT INTO Channels (Name, IsPublic) VALUES ('initialname', true)
The Channels table allows updates for columns Name, Purpose, and Topic when Id is specified.
UPDATE Channels SET Topic = 'A Topic Text', Purpose = 'A Purpose Text', Name = 'updatedname' WHERE Id = 'D71R6CSR1'
Slack does not allow Channels to be deleted.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The Id of the channel. | |
| Name | String | False |
The name of the channel. | |
| Topic | String | False |
Information about the channel topic. | |
| TopicCreator | String | True |
The creator of the channel topic. | |
| Purpose | String | False |
Information about the channel purpose. | |
| TotalMembers | Integer | True |
The number of members in the channel. | |
| Created | Datetime | True |
The datetime of the Channel creation. | |
| Creator | String | True |
Users.Id |
The user ID of the member that created this channel. |
| LastRead | Datetime | True |
The datetime for the last message the calling user has read in this channel. | |
| IsMember | Boolean | True |
Indicates whether the user, bot user, or Slack app associated with the token making the API call is itself a member of the conversation. | |
| IsArchived | Boolean | True |
Indicates whether a conversation is archived. | |
| IsPublic | Boolean | False |
Indicates whether a conversation is a public channel. Everything said in a public channel can be read by anyone else belonging to a workspace. | |
| IsGroup | Boolean | True |
Indicates whether the channel is a private channel between a group of members. | |
| IsDirectMessage | Boolean | True |
Indicates whether the conversation is a direct message between two distinguished individuals or a user and a bot. | |
| IsMultipartyDirectMessage | Boolean | True |
Represents an unnamed private conversation between multiple users. | |
| IsGeneral | Boolean | True |
Indicates whether the channel is the workspace's 'general' discussion channel. | |
| Unlinked | Integer | True |
Number of times a link to the channel has been removed. | |
| NameNormalized | String | True |
The normalized name of the channel. | |
| IsShared | Boolean | True |
Indicates whether the conversation is in some way shared between multiple workspaces. | |
| IsExtShared | Boolean | True |
Indicates whether this conversation is part of a Shared Channel with a remote organization. | |
| IsOrgShared | Boolean | True |
Indicates whether this shared channel is shared between Enterprise Grid workspaces within the same organization. | |
| IsPendingExtShared | Boolean | True |
Indicates whether the conversation is ready to become an IsExtShared channel but needs some kind of approval or sign off. | |
| PreviousNames | String | True |
A list of previous names this channel has had. | |
| Locale | String | True |
The locale of the channel. | |
| User | String | True |
The Id of the user. | |
| IsUserDeleted | Boolean | True |
Indicates whether the user is deleted. | |
| Priority | String | True |
The priority of the channel. | |
| ItemURL | String | True |
The URL of the Channel. | |
| IsPrivate | Boolean | True |
Indicates whether a conversation is a private channel. | |
| IsChannel | Boolean | True |
Indicates whether a conversation is a channel. | |
| IsFrozen | Boolean | True |
Indicates whether a conversation is frozen. | |
| PendingShared | String | True |
The pending shared. | |
| ContextTeamId | String | True |
The context team Id. | |
| Updated | Timestamp | True |
The timestamp, in milliseconds, when the channel settings were updated (for example, the 'topic' or 'description' of the channel changed). | |
| TopicLastSet | Datetime | True |
Provides information about the channel topic. | |
| ParentConversation | String | True |
The parent conversation. | |
| SharedTeamIds | String | True |
The Ids of the shared teams. | |
| PendingConnectedTeamIds | String | True |
The Ids of the pending connected teams. | |
| PurposeCreator | String | True |
The creator of the channel purpose. | |
| PurposeLastSet | Datetime | True |
Provides information about the channel purpose. | |
| Properties | String | True |
Additional channel properties. |
Pseudo column fields are used in the WHERE clause of SELECT statements. These offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| TeamId | String |
The Id of the team. DEPRECATED. |
| ChannelType | String |
The type of channel to include or exclude in the search. To filter with channel type, UseSearch property must be enabled. Possible values are : private, private_exclude, archived, exclude_archived, private_exclude_archived, multi_workspace, org_wide, external_shared_exclude, external_shared, external_shared_private, external_shared_archived, exclude_org_shared |
Retrieve members of a conversation.
You must specify the ChannelId column in the WHERE clause to query the ConversationMembers view.
The Sync App uses the Slack API to process search criteria that refer to the ChannelId column. This column supports server-side processing for the = operator. The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM ConversationMembers WHERE ChannelId = 'C01KWCPJJ68'
Members can be removed from the conversation by specifying the ChannelId and MemberId.
DELETE FROM ConversationMembers WHERE ChannelId = 'D71R6CSR1' AND MemberId = 'U03AZBU3CMT'
| Name | Type | ReadOnly | References | Description |
| MemberId | String | True |
ID of the member. | |
| ChannelId | String | True |
Channels.Id |
ID of the conversation to retrieve members for. |
Query and delete team files.
The Sync App will use the Slack API to filter by search criteria that refer to the Id, Created, UserId, Types, SpecificChannel, or SearchTerm columns. All columns support server-side processing for the = operator, and the Created column also supports server-side processing for the >, >=, <, <= operators.
The Sync App processes other search criteria client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Files WHERE Created > '2017-01-01' AND UserId = 'U2345NDS' AND SpecificChannel = 'D71R6CSR1'
You can also filter files by querying the files' contents: Set the SearchTerm pseudocolumn in the criteria. All files containing the queried word will be retrieved. For example:
SELECT * FROM Files WHERE SearchTerm = 'text'
Slack does not allow inserting new files.
Slack does not allow updating files.
Files can be deleted by providing the Id of the file.
DELETE FROM Files WHERE Id = 'F71R6DRR1'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The Id of the file. | |
| Name | String | True |
The name of the file, which may be null for unnamed files. | |
| Title | String | True |
The title of the file. | |
| Created | Datetime | True |
The creation date of the file. | |
| UserId | String | True |
Users.Id |
The user ID of the member that created this file. |
| Username | String | True |
The username of the file creator. | |
| InitialComment | String | True |
A comment from the file uploader, which is only set when the uploader left a comment at the time of upload. | |
| Size | Integer | True |
The filesize in bytes. Snippets are limited to a maximum file size of 1 megabyte. | |
| Filetype | String | True |
The type of the file. | |
| Mimetype | String | True |
The Mime type of the file. | |
| PrettyType | String | True |
The human-readable version of the type. | |
| CommentsCount | Integer | True |
The number of comments made on the file. | |
| Mode | String | True |
A property that contains one of hosted, external, snippet or post. | |
| PublicChannelIds | String | True |
A list of channel IDs in which the file is currently shared. | |
| GroupIds | String | True |
A list of private groups IDs in which the file is currently shared. | |
| DirectMessageIds | String | True |
A list of instant message IDs in which the file is currently shared. | |
| Editable | Boolean | True |
Indicates whether files are stored in editable mode. | |
| Permalink | String | True |
The URL that points to a single page for the file containing details, comments and a download link. | |
| PermalinkPublic | String | True |
If the file is available to the public, this URL points to the public file itself. | |
| EditLink | String | True |
The page where the file can be edited. This is available for posts and snippets. | |
| UrlPrivate | String | True |
The URL that points to the file contents. | |
| UrlPrivateDownload | String | True |
For editable-mode files, this parameter includes headers to force a browser download. | |
| Thumb480 | String | True |
The URL of a 480x480 thumbnail. | |
| IsExternal | Boolean | True |
Indicates whether the master copy of a file is stored within the system. If the file is external, then the URL property will point to the externally-hosted master file. | |
| ExternalType | String | True |
Indicates the type of external file, such as dropbox or gdoc. | |
| IsPublic | Boolean | True |
Indicates whether the file is public. | |
| PublicUrlShared | Boolean | True |
Indicates whether the file's public URL has been shared. | |
| DisplayAsBot | Boolean | True |
Indicates whether the file should be displayed as a bot. | |
| ImageExifRotation | Integer | True |
Image Exchangeable Image File Format (EXIF) Rotation. | |
| OriginalW | Integer | True |
The width dimensions of the original file. | |
| OriginalH | Integer | True |
The height dimensions of the original file. | |
| DeanimateGif | String | True |
Deanimate gif. | |
| PJpeg | String | True |
The progressive JPEG (PJpeg). | |
| IsStarred | Boolean | True |
Indicates whether the calling user has starred the file, else it is omitted. | |
| HasRichPreview | Boolean | True |
Indicates whether the file has rich preview. | |
| Thumb64 | String | True |
The URL of a 64x64 thumbnail. | |
| Thumb80 | String | True |
The URL of a 80x80 thumbnail. | |
| Thumb160 | String | True |
The URL of a 160x160 thumbnail. | |
| Thumb360 | String | True |
The URL of a 360x360 thumbnail. | |
| Thumb720 | String | True |
The URL of a 720x720 thumbnail. | |
| Thumb960 | String | True |
The URL of a 960x960 thumbnail. | |
| Thumb1024 | String | True |
The URL of a 1024x1024 thumbnail. | |
| Thumb360W | Integer | True |
The width dimensions for a 360x360 thumbnail. | |
| Thumb360H | Integer | True |
The height dimensions for a 360x360 thumbnail. | |
| Thumb480W | Integer | True |
The width dimensions for a 480x480 thumbnail. | |
| Thumb480H | Integer | True |
The height dimensions for a 480x480 thumbnail. | |
| Thumb360Gif | String | True |
An animated thumbnail. | |
| Shares | String | True |
Information about the files that are shared. | |
| PreviewIsTruncated | Boolean | True |
Indicates whether preview is truncated. | |
| Lines | Integer | True |
The total count of lines in the snippet. | |
| LinesMore | Integer | True |
A count of lines not shown in the preview. | |
| UserTeam | String | True |
The URL of a 480x480 thumbnail. | |
| Preview | String | True |
The preview of the file. | |
| PreviewHighlight | String | True |
The preview highlight of the file. |
Pseudo column fields are used in the WHERE clause of SELECT statements. These offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| SpecificChannel | String |
Filter files appearing in a specific channel, indicated by its ID. |
| SearchTerm | String |
Filter by this column to retrieve all files that contain the word in the criteria. |
| Types | String |
Filter files by type. Allowed values are all, spaces, snippets, images, gdocs, or zips. The default value is all. The allowed values are all, spaces, snippets, images, gdocs, zips. |
Create, update, delete, and query threads of messages posted to a conversation.
The Sync App uses the Slack API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the Sync App.
The MessageReplies table requires ChannelId and ParentMessageId columns in the WHERE clause; otherwise, the driver will automatically add these columns.
For example, the following query is processed server side:
SELECT * FROM MessageReplies WHERE ChannelId = 'D71R6CSR1' AND ParentMessageId = '1234567890.123456'
Slack allows inserts only when ChannelId, Text, and ParentMessageId are specified.
INSERT INTO MessageReplies (ChannelId, Text, ParentMessageId) VALUES ('D71R6CSR1', 'This is a message', '1234567890.123456')
The MessageReplies table allows updates only for the Text field. Specify ChannelId and Id.
UPDATE MessageReplies SET Text = 'Updated message' WHERE ChannelId = 'D71R6CSR1' AND Id = '1234567890.123456'
MessageReplies can be deleted by providing the ChannelId and the Id of the message.
DELETE FROM MessageReplies WHERE ChannelId = 'D71R6CSR1' AND Id = '1234567890.123456
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Unique identifier for the messages. | |
| ChannelId [KEY] | String | False |
Channels.Id |
Conversation ID to fetch thread from. |
| UserId | String | True |
Users.Id |
User Id of the user who posted the reply. |
| Text | String | False |
Reply message content. | |
| ParentMessageId [KEY] | String | False |
Messages.Id |
Unique identifier of a thread's parent message. |
| ReplyCount | Integer | True |
The replies number for thread's parent message. | |
| Subscribed | Boolean | True |
Indicates if the user is subscribed to this channel. | |
| LastRead | Datetime | True |
The datetime for the last message the calling user has read in this channel. | |
| UnreadCount | Integer | True |
The number of members that have not read the parent message. | |
| CreatedTime | Datetime | True |
The created date time of the message reply. | |
| ParentCreatedTime | Datetime | True |
The parent message created date time. |
Create, update, delete, and query the available messages in Slack.
The Sync App uses the Slack API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the Sync App.
Note: The Messages table requires ChannelId or SearchTerm in the WHERE clause. In the case of a simple select, the Slack automatically adds the ChannelId where the current user is a member of the channel to the WHERE clause.
SELECT * FROM Messages WHERE ChannelId = 'D71R6CSR1' SELECT * FROM Messages WHERE SearchTerm = 'text' SELECT * FROM Messages WHERE CreatedTime >= '7-30-2023 00:00:00' AND CreatedTime <= '8-4-2023 00:00:00'
Slack allows inserts only when ChannelId and Text are specified.
INSERT INTO Messages (ChannelId, Text) VALUES ('D71R6CSR1', 'This is a message')
The Messages table allows updates only for the Text field. Specify ChannelId and Id.
UPDATE Messages SET Text = 'Updated message' WHERE ChannelId = 'D71R6CSR1' AND Id = '1234567890.123456'
Messages can be deleted by providing the ChannelId and the Id of the message.
DELETE FROM Messages WHERE ChannelId = 'D71R6CSR1' AND Id = '1234567890.123456'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The Id of the message. | |
| ChannelId [KEY] | String | False |
Channels.Id |
The Id of the channel the message was posted to. |
| UserId | String | True |
Users.Id |
The Id of the user that posted the message. |
| Text | String | False |
The text of the message. | |
| Type | String | True |
The message type. | |
| Item_type | String | True |
The item type of the message. | |
| Subtype | String | True |
The item subtype of the message. | |
| Team | String | True |
The team of the message. | |
| Pinned_to | String | False |
The pinned details of the message. | |
| Pinned_info_Channel | String | True |
The Id of the pinned channel of the message. | |
| Pinned_info_pinned_by | String | True |
The Id of the pinned by message. | |
| Pinned_info_pinned_ts | String | True |
The Id of the pinned message of the message. | |
| AttachmentsAggregate | String | True |
The attachments made to the message. | |
| Purpose | String | False |
The purpose of the message. | |
| BotId | String | True |
The BotId of the message. | |
| BotLink | String | True |
The BotLink of the message. | |
| Username | String | True |
The UserName of the message. | |
| Reply_count | Integer | False |
The count of the replied channels to the message. | |
| Reply_users_count | Integer | False |
The count of the replied users to the message. | |
| Latest_reply | String | True |
The latest message reply of the message. | |
| Last_read | String | True |
The last read message. | |
| Reply_usersAggreagte | String | True |
The replied user details of the message. | |
| Subscribed | Boolean | True |
The subscribed status of the message. | |
| Topic | String | True |
Topic of the message. | |
| Old_name | String | False |
Old Name of the message. | |
| Name | String | False |
Name of the message. | |
| SearchTerm | String | True |
Filter by this column to retrieve all messages that contain the word in the criteria. | |
| UserEditedDate | String | True |
The date of the edited message. | |
| UserEditedId | String | True |
The user Id of the edited message. | |
| CreatedTime | Datetime | True |
The created date time of the message. | |
| ItemURL | String | True |
The URL of the item. | |
| Files | String | True |
The files associated with the message. | |
| Blocks | String | True |
The blocks associated with the message. | |
| Reactions | String | True |
The reactions associated with the message. | |
| Upload | Boolean | True |
Indicates whether the file is uploaded. | |
| ClientMsgId | String | True |
The Id of the Client Message. | |
| IsLocked | Boolean | True |
Indicates whether the message is locked. | |
| AppId | String | True |
The App Id of the Slack app. | |
| DisplayAsBot | Boolean | True |
Indicates whether to display the message as a bot. | |
| ParentMessageId | String | True |
The parent message Id. |
Create, delete, and query all items pinned to a channel.
You must specify the ChannelId column in the WHERE clause to query the Pins table.
The Sync App will use the Slack API to process search criteria that refer to the ChannelId column. This column supports server-side processing for the = operator. The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Pins WHERE ChannelId = 'D71R6CSR1'
INSERTS are allowed when you specify the ChannelId and Id. For example:
INSERT INTO Pins (ChannelId, Id) VALUES ('D71R6CSR1', 'F71R6DRR1')
Slack does not support UPDATE for pins.
You can delete a pin by providing the ChannelId and Id.
DELETE FROM Pins WHERE ChannelId = 'D71R6CSR1' AND Id = '1505287261.000226'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id of the pinned item. | |
| Type [KEY] | String | True |
The type of the pinned item. | |
| Created | Datetime | True |
A unique datetime representing when the item was pinned. | |
| ChannelId [KEY] | String | False |
Channels.Id |
Channel Id to get pinned items for. |
| PinnedToChannelIds | String | True |
Channels.Id |
Comma separated list of channel ids the item is pinned to. |
| CreatedBy | String | True |
Users.Id |
The encoded user id of the user who pinned the item. |
Create, delete, and query reactions on items.
The Sync App processes the filters client-side within the Sync App.
SELECT * FROM Reactions
SELECT * FROM Reactions WHERE Users = 'U046AV8HU3G'
SELECT * FROM Reactions WHERE Team = 'T046W75LRTK'
SELECT * FROM Reactions WHERE Team = 'T046W75LRTK' AND Users = 'U046AV8HU3G'
Inserts are allowed when you specify the ChannelId, Id, and Name. For example:
INSERT INTO Reactions (ChannelId, Id, Name) VALUES ('C04HBS2PS56', '1672114112.994259', 'raised_hands')
Slack does not support UPDATE for reactions.
You can delete a reaction by providing the ChannelId, Id, and Name.
DELETE FROM Reactions WHERE Name = 'raised_hands' AND ChannelId = 'C04HBS2PS56' AND Id = '1672114112.994259'
| Name | Type | ReadOnly | References | Description |
| Id | String | False |
The Id of the reacted item. | |
| ChannelId | String | False |
Channels.Id |
The ChanneldId where item is reacted |
| Type | String | True |
The type of the reacted item. | |
| Name | String | False |
The name of the reaction. | |
| Count | String | True |
The count of reactions on that message | |
| Users | String | True |
The encoded user id of the user who reacted to the message. | |
| Team | String | True |
The Team Id of the reaction. |
Create, delete, and query all reminders by or for a given user.
The Sync App uses the Slack API to process search criteria that refer to the Id column while other filters are processed client-side within the Sync App. For example, the following query is processed server side:
SELECT * FROM Reminders WHERE Id = 'RT7U7LN6F'
Inserts are allowed when you specify the Text and Time for the reminder. You can also add UserId. For example:
INSERT INTO Reminders (Text, Time, UserId) VALUES ('Remind me for coffee', '2017-01-01 10:00', 'U723764DF')
To insert with recurring patterns like "every tuesday" and intervals like "in 15 minutes" use the Frequency column.
INSERT INTO Reminders (Text, Frequency, UserId) VALUES ('Remind me for coffee', 'every tuesday', 'U723764DF')
Slack does not support UPDATE for reminders.
You can delete a reminder by providing the Id.
DELETE FROM Reminders WHERE Id = 'R71R6CSR1'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The Id of the reminder. | |
| Creator | String | True |
Users.Id |
The Id of the user who created the reminder. |
| UserId | String | False |
Users.Id |
The Id of the user the reminder is set for. |
| Text | String | False |
The content of the reminder. | |
| Recurring | Boolean | True |
Indicates if this reminder is to be repeated. | |
| Time | Datetime | False |
The datetime of the reminder. Only non-recurring reminders will return value for this column. | |
| CompleteTimestamp | Datetime | True |
The datetime when the reminder was completed. Only non-recurring reminders will return value for this column. | |
| Frequency | String | False |
Recurring frequency of the reminder. Only recurring reminders will return value for this column. Examples for insert: 'in 15 minutes' or 'every Thursday'. | |
| RecurrenceWeekdays | String | True |
Recurring days for the reminder. Only recurring reminders will return value for this column. |
Query all scheduled messages.
The Sync App will use the Slack API to filter by search criteria that refer to the ChannelId, PostAt and TeamId columns. All columns support server-side processing for the = operator, and the PostAt column also supports server-side processing for the >, >=, <, <= operators.
The Sync App processes other search criteria client-side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM ScheduledMessages WHERE ChannelId = 'D064Q184VGA' SELECT * FROM ScheduledMessages WHERE TeamId = 'T01LC4ASB2M' SELECT * FROM ScheduledMessages WHERE PostAt >= '07-01-2024 00:00:00' and PostAt <= '07-31-2024 00:00:00'
Scheduled Messages can be deleted by providing the ChannelId and the Id of the scheduled message.
DELETE FROM ScheduledMessages WHERE ChannelId = 'D71R6CSR1' AND Id = 'Q07SJJT75CN'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The Id of the scheduled message. | |
| ChannelId | String | True |
The Id of the Channel. | |
| PostAt | Datetime | True |
The date the message was posted. | |
| CreatedTime | Datetime | True |
The date the message was created. | |
| Text | String | True |
The text of the scheduled message. |
Pseudo column fields are used in the WHERE clause of SELECT statements. These offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| TeamId | String |
Team id to list channels in, required if org token is used. |
| AsUser | String |
The Id of the user. |
Create, update, and query all User Groups for a Slack team.
The Sync App uses the Slack API to process search criteria that refer to the IncludeDisabled column while other search criteria are processed client-side within the Sync App. For example, the following query is processed server side:
SELECT * FROM UserGroups WHERE IncludeDisabled = 'true'
Inserts are allowed only for paid workspaces and when you specify the Name of the user group. Other optional fields are Description, Handle, and PreferredChannelIds. For example:
INSERT INTO UserGroups (Name, PreferredChannelIds) VALUES ('newgroup', 'C5S8LAY0Y,C79J7PREU')
You can update a user group by providing the Id and you can update the UserIds, Name, Description, PreferredChannelIds, and Handle columns. Updates are only allowed for paid workspaces.
UPDATE UserGroups SET PreferredChannelIds = 'C5S8LAY0Y,C79J7PREU', Name = 'newname' WHERE Id = 'U4826PEF'
Slack does not support the deletion of user groups.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The Id of the User Group. | |
| Name | String | False |
Indicates the friendly name of the group. | |
| Description | String | False |
Explains the purpose of the group. | |
| TeamId | String | True |
Identifier of the team this user group belongs to. | |
| UserIds | String | False |
Contains a list of user id values that belong to the User Group. | |
| UserCount | String | True |
Indicates the total number of users in a group. | |
| Handle | String | False |
Indicates the value used to notify group members via a mention without a leading @ sign. | |
| PreferredChannelIds | String | False |
Channels that members of this group will be invited to upon joining. | |
| PreferredGroupsIds | String | True |
Groups (private channels) that members of this group will be invited to upon joining. | |
| IsExternal | Boolean | True |
Represents this conversation as being externally shared. | |
| DateCreated | Datetime | True |
Datetime of the creation of the user group. | |
| DateUpdated | Datetime | True |
Datetime of the last update made for the user group. | |
| DateDeleted | Datetime | True |
Datetime that the user group became disabled. | |
| CreatedBy | String | True |
Users.Id |
Id of the user who created the user group. |
| UpdatedBy | String | True |
Users.Id |
Id of the user who last modified the user group. |
| DeletedBy | String | True |
Users.Id |
Id of the user who disabled/archived the user group. |
| AutoType | String | True |
This parameter's value can be admins for a Workspace Admins group, owners for a Workspace Owners group or null for a custom group. |
Pseudo column fields are used in the WHERE clause of SELECT statements. These offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| IncludeDisabled | Boolean |
A boolean set to include or exclude disabled User Groups in the retrieved data. |
Retrieve a user's profile information, including their custom status. This table supports only Select and Update operations.
The Sync App will use the Slack API to process search criteria that refer to the UserId column. This column support server-side processing for the =,IN operator. The Sync App processes other filters client-side within the Sync App.
For example, the following queries are processed server side by the Slack APIs:
SELECT * FROM UserProfile WHERE UserId='W1234567890';
SELECT * FROM UserProfile WHERE UserId in ('W1234567890','W1234567891','W1234567892');
Slack does not support inserting new users.
There are a number of requirements for updating the user profile:
You can update a user profile by providing the Id of the user. For example:
UPDATE UserProfile SET DisplayName = 'Steve', RealName='Steve Smith' , customfields='{"Xf0111111": {"value": "Engineer","alt": ""},"Xf0222222":{"value": "2022-04-11","alt": ""}}', StatusText='riding a train', StatusEmoji=':train:' WHERE userId = 'W1234567890';
Slack does not support deleting users.
| Name | Type | ReadOnly | References | Description |
| AvatarHash | String | True |
Avatar Hash | |
| DisplayName | String | False |
The display name the user has chosen to identify themselves by in their workspace profile. | |
| DisplayNormalisedName | String | True |
The DisplayName field, but with any non-Latin characters filtered out. | |
| String | False |
The Email of the user. The users:read.email OAuth scope is required to access the email field. | ||
| CustomFields | String | False |
All the custom profile fields for the user. | |
| FirstName | String | False |
The user's first name | |
| LastName | String | False |
The user's last name. | |
| Phone | String | False |
The user's phone number, in any format. | |
| ProfileImage1024 | String | True |
URL to square, web-viewable image of a user's profile of size 1024. | |
| ProfileImage192 | String | True |
URL to square, web-viewable image of a user's profile of size 192. | |
| ProfileImage24 | String | True |
URL to square, web-viewable image of a user's profile of size 24. | |
| ProfileImage32 | String | True |
URL to square, web-viewable image of a user's profile of size 32. | |
| ProfileImage48 | String | True |
URL to square, web-viewable image of a user's profile of size 48. | |
| ProfileImage512 | String | True |
URL to square, web-viewable image of a user's profile of size 512. | |
| ProfileImage72 | String | True |
URL to square, web-viewable image of a user's profile of size 72. | |
| ProfileImageOriginal | String | True |
URL to square, web-viewable image of a user's profile of original size. | |
| IsCustomImage | Boolean | True |
Whether the image of a user's profile is custom image or not. | |
| Pronouns | String | False |
The pronouns the user prefers to be addressed by. | |
| HuddleState | String | True |
Huddle state of the user. | |
| HuddleStateCallId | String | True |
Call Id of the huddle state | |
| HuddleStateExpirationTime | Datetime | True |
The timestamp of when the huddle state will expire. | |
| RealName | String | False |
The user's first and last name. | |
| RealNormalisedName | String | True |
The RealName field, but with any non-Latin characters filtered out. | |
| Skype | String | True |
A shadow from a bygone era. It will always be an empty string and cannot be set otherwise. | |
| StartDate | String | False |
The date the person joined the organization. | |
| StatusEmoji | String | False |
The displayed emoji that is enabled for the Slack team, such as :train:. | |
| StatusEmojiDisplayInfo | String | True |
The information about the status emoji display. | |
| StatusExpireTime | Datetime | False |
The timestamp of when the status will expire. Providing 0 or omitting this field results in a custom status that will not expire. | |
| StatusText | String | False |
The displayed text of up to 100 characters. | |
| StatusTextCanonical | String | False |
The Status text of the user. | |
| Title | String | False |
The user's title. |
Pseudo column fields are used in the WHERE clause of SELECT statements. These offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| UserId | String |
User Id to retrieve profile info for. |
| IncludeLabels | String |
Include labels for each ID in custom profile fields. Using this parameter will heavily rate-limit your requests and is not recommended. Default value is False |
Update and query all users for a Slack team.
The Sync App uses the Slack API to process search criteria that refer to the Id column, while other filters are processed client-side within the Sync App. For example, the following query is processed server side:
SELECT * FROM Users WHERE Id = 'U5SU7GU6N'
Slack does not support inserting new users.
You can update a user's FirstName, LastName, ProfileDisplayName, and ProfileEmail by providing the Id of the user. Only a team admin of a paid team can update another user's profile.
UPDATE Users SET ProfileDisplayName = 'Dis Name', ProfileEmail = '[email protected]' WHERE Id = 'U5SU7GU6N'
Slack does not support deleting users.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The Id of the User. | |
| FirstName | String | False |
Fist name of the user. | |
| LastName | String | False |
Last name of the user. | |
| FullName | String | True |
Full name of the user. | |
| ProfileDisplayName | String | False |
Display name of the user. | |
| ProfileEmail | String | False |
Email of the user. | |
| ProfileImage | String | True |
URLs to square, web-viewable image of a user's profile. | |
| Deleted | Boolean | True |
Indicates if the user is deactivated. | |
| TeamId | String | True |
Id of the Slack team the user belongs to. | |
| IsAdmin | Boolean | True |
Indicates whether the user administers this team. | |
| Color | String | True |
A field used in some clients to display a colored username. | |
| Timezone | String | True |
String for the geographic region. | |
| TimezoneLabel | String | True |
String describing the name of that timezone. | |
| TimezoneOffset | Integer | True |
A signed integer indicating the number of seconds to offset UTC time by. | |
| IsOwner | Boolean | True |
Indicates whether this user is the owner of this team. | |
| IsPrimaryOwner | Boolean | True |
Indicates whether this user is the primary owner of this team. | |
| IsRestricted | Boolean | True |
Indicates whether this user is restricted from the team . | |
| IsUltraRestricted | Boolean | True |
Indicates whether this user is forbidden from the team. | |
| Updated | Datetime | True |
A datetime that shows when the user was last updated. | |
| IsAppUser | Boolean | True |
A boolean value indicating if the user uses the Slack App. | |
| Has2fa | Boolean | True |
A boolean value indicating if the user uses Two Factor Authentication. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| Dnd | Retrieves a user's current Do Not Disturb status. |
| Team | Retrieves information about the current team. |
| TeamAccessLogs | Gets the access logs for the current team. |
| TeamInfo | Retrieves the Do Not Disturb status for up to 50 users on a team. |
| TeamProfileFields | Retrieves a team profile's Fields |
| TeamProfileSections | Retrieves a team profile's Sections |
| UsersPresence | Query user's presence information. Defaults to the authed user. |
Retrieves a user's current Do Not Disturb status.
The Sync App processes filters client-side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Dnd
| Name | Type | References | Description |
| DndEnabled | Boolean | The DND status of the user. | |
| NextDndEndTs | Datetime | The timestamp when the upcoming DND session ends. | |
| NextDndStartTs | Datetime | The timestamp when the upcoming DND session starts. | |
| SnoozeEnabled | Boolean | The snooze status of the user. Visible only if the user is the current user. | |
| SnoozeEndtime | Datetime | The time when snooze ends. Visible only if the user is the current user. | |
| SnoozeIsIndefinite | Boolean | Indicates snooze does not end automatically. Visible only if the user is the current user. | |
| SnoozeRemaining | Datetime | The time remaining until snooze ends. Visible only if the user is the current user. |
Retrieves information about the current team.
The Sync App uses the Slack API to filter by search criteria that refer to the Id column. The column supports server-side processing for the = operator.
The Sync App processes filters client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Team
SELECT * FROM Team WHERE Id = 'T01LC4ASB2M'
| Name | Type | References | Description |
| Domain | String | The domain of the team. | |
| EmailDomain | String | The email of the domain of the team. | |
| Id [KEY] | String | The Id of the team. | |
| Name | String | The name of the team. | |
| EnterpriseId | String | The Enterprise Id of the team. | |
| EnterpriseName | String | The Enterprise Name of the team. | |
| Icon | String | The Icon of the team. | |
| IsVerified | Boolean | Indicates whether the team is verified. | |
| LobSalesHomeEnabled | Boolean | Indicates the Sales Home status. | |
| Url | String | The URL of the team. | |
| AvatarBaseUrl | String | The Avatar base URL of the team. |
Gets the access logs for the current team.
The Sync App uses the Slack API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the Sync App.
The TeamAccessLogs table requires TeamId column in the WHERE clause; otherwise, the driver will automatically add the column.
SELECT * FROM TeamAccessLogs WHERE TeamId = 'T01LC4ASB3M'
| Name | Type | References | Description |
| TeamId [KEY] | String | The Id of the team. | |
| UserId | String | The Id of the user who accessed Slack. | |
| Username | String | The username of the user who accessed Slack. | |
| DateFirst | Datetime | The first login date time. | |
| DateLast | Datetime | The last login date time. | |
| Count | Integer | The login count. | |
| IP | String | The IP address of the user. | |
| UserAgent | String | The user agent with which the user logged in. | |
| Isp | String | The internet service provider. | |
| Country | String | The country where the access originated. | |
| Region | String | The region where the access originated. |
Retrieves the Do Not Disturb status for up to 50 users on a team.
The Sync App uses the Slack API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the Sync App.
The TeamInfo table requires the User column in the WHERE clause; otherwise, the driver automatically adds the column.
SELECT * FROM TeamInfo WHERE User = 'U01KZFNNTPC'
SELECT * FROM TeamInfo WHERE User IN ('U01KZFNNTPC','U04QTH44D9S')
| Name | Type | References | Description |
| User | String | The Id of the user. | |
| DndEnabled | Boolean | Indicates whether DND is enabled. | |
| NextDndStartTime | Datetime | The next DND Start time. | |
| NextDndEndTime | Datetime | The next DND End time. |
Retrieves a team profile's Fields
The Sync App uses the Slack API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the Sync App.
SELECT * FROM TeamProfileFields
SELECT * FROM TeamProfileFields WHERE IsHidden = false
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the field. | |
| Ordering | Integer | The placement of the field on the profile. | |
| Label | String | The text that will appear under the field. | |
| Hint | String | Any additional context the user may need to understand the field. | |
| Type | String | The format the field supports. Can be date, link, long_text, options_list, tags, text, or user. | |
| PossibleValues | String | The values that allowed to be chosen by the user. | |
| OptionsIsScim | Boolean | If true, can be updated via SCIM APIs. | |
| OptionsIsProtected | Boolean | ||
| IsHidden | Boolean | Indicates whether the field is hidden or not. | |
| SectionId | String | The id of the section the field is in. |
Retrieves a team profile's Sections
The Sync App processes filters client-side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM TeamProfileSections
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the section. | |
| TeamId | String | The Id of the Team. | |
| Order | Integer | The placement of the section on the profile. | |
| Label | String | The text that will appear under the section. | |
| SectionType | String | The type of content in the section. Users can only create custom section types. | |
| IsHidden | Boolean | Indicates whether the section is hidden or not. |
Query user's presence information. Defaults to the authed user.
You must specify the UserId column in the WHERE clause to query the UsersPresence view. If not specified, the presence information will be fetched for the authed user.
The Sync App uses the Slack API to process search criteria that refer to the UserId column. This column supports server-side processing for the = operator. The Sync App processes other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM UsersPresence WHERE UserId = 'U03AZBU3CMT'
SELECT * FROM UsersPresence WHERE UserId IN ('U03AZBU3CMT', 'U03AZBU3CZH')
| Name | Type | References | Description |
| UserId [KEY] | String | The Id of the User. | |
| Presence | String | User's current presence (either active or away). | |
| Online | Boolean | User's online status. | |
| AutoAway | Boolean | User status is away automatically. | |
| ManualAway | Boolean | User status is away manually. | |
| ConnectionCount | Integer | The connection count. | |
| LastActivity | Datetime | Last activity of the user. |
Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Slack.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Slack, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| AddProfilePhoto | Set the authenticated user's profile photo. Supported formats for Profile photo are jpeg, gif and png. |
| CloseChannel | Closes a direct message or multiperson direct message. |
| DisableUserGroup | Disable an existing User Group. |
| EnableUserGroup | Enable a User Group. |
| EndCall | Ends a Call. |
| EndDnd | Ends the current user's Do Not Disturb session immediately. |
| EndSnooze | Ends the current user's snooze mode immediately. |
| GetPermaLink | Retrieve a permalink URL for a specific extant message. |
| GetTeamBillableInfo | Reads a workspace's billing plan information. |
| InviteUser | Invites users to a channel. |
| JoinChannel | Joins an existing conversation. |
| JoinMultipleChannels | Joins the existing muliple channels. |
| LeaveChannel | Leaves a conversation. |
| OpenChannel | Opens or resumes a direct message or multiperson direct message. |
| RemoveProfilePhoto | Deletes the authenticated user's profile photo. |
| SendEphemeralMessage | Sends an ephemeral message to a user in a channel. |
| SendScheduleMessage | Schedules a message to be sent to a channel. |
| SetReadCursor | Sets the read cursor in a channel. |
| SetSnooze | Turns on Do Not Disturb mode for the current user, or changes its duration. |
| ShareMeMessage | Share a me message into a channel. |
Set the authenticated user's profile photo. Supported formats for Profile photo are jpeg, gif and png.
| Name | Type | Description |
| FilePath | String | The full path to the image file to upload. |
| Name | Type | Description |
| Success | String | The result of the procedure. |
Closes a direct message or multiperson direct message.
| Name | Type | Description |
| ChannelId | String | Id of the conversation to close. |
| Name | Type | Description |
| Success | String | The result of the procedure. |
Disable an existing User Group.
Slack allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required scopes to execute this SP is usergroups:write.
For example:
EXECUTE DisableUserGroup UserGroup = 'S0604QSJC', IncludeCount = true
| Name | Type | Description |
| UserGroup | String | The ID of the User Group to disable. |
| IncludeCount | String | Boolean value that represents whether to include the number of users in the User Group. |
| TeamId | String | Target team id where the user group is, required if org token is used. |
| Name | Type | Description |
| Success | String | The result of the procedure. |
Downloads a file.
| Name | Type | Description |
| FileId | String | The Id of the file to be downloaded |
| FileLocation | String | The location where file is to be downloaded |
| Encoding | String | The FileData input encoding type.
The allowed values are NONE, BASE64. The default value is BASE64. |
| Name | Type | Description |
| FileData | String | If the FileLocation and FileStream are not provided, this contains the content of the file. |
| Success | String | The result of the procedure. |
Enable a User Group.
Slack allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required scopes to execute this SP is usergroups:write.
For example:
EXECUTE EnableUserGroup UserGroup = 'S0604QSJC', IncludeCount = true
| Name | Type | Description |
| UserGroup | String | The ID of the User Group to enable. |
| IncludeCount | String | Boolean value that represents whether to include the number of users in the User Group. |
| TeamId | String | Team id where the user group is, required if org token is used. |
| Name | Type | Description |
| Success | String | The result of the procedure. |
Ends a Call.
| Name | Type | Description |
| CallId | String | The Id returned when registering the call. |
| Duration | String | Call duration in seconds. |
| Name | Type | Description |
| Success | String | The result of the procedure. |
Ends the current user's Do Not Disturb session immediately.
| Name | Type | Description |
| Success | String | The result of the procedure. |
Ends the current user's snooze mode immediately.
| Name | Type | Description |
| Success | String | The result of the procedure. |
| DndEnabled | String | Indicates whether DND is enabled. |
| NextDndStartTime | Datetime | The next DND Start Time. |
| NextDndEndTime | Datetime | The next DND End Time. |
| SnoozeEnabled | String | Indicates whether snooze is enabled. |
Gets an authentication token from Slack.
| Name | Type | Description |
| AuthMode | String | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
The allowed values are APP, WEB. The default value is APP. |
| Scope | String | The list of permissions to request from the user. Please check the Slack API for a list of available permissions. If not provided then the default scopes will be passed. For v2 the default scopes are: 'channels:read, groups:read, im:read, mpim:read, channels:write, groups:write, im:write, mpim:write, channels:history, groups:history, im:history, mpim:history, search:read, files:read, pins:read, pins:write, usergroups:read, usergroups:write, reminders:read, reminders:write, users:read, users.profile:read, users.profile:write, team.billing:read' and for openid the default scopes are 'openid profile email'. |
| CallbackURL | String | Determines where the response is sent. The value of this parameter must exactly match one of the values registered in the settings for the app (including the HTTP or HTTPS schemes, capitalization, and trailing '/'). |
| Verifier | String | The verifier returned from Slack after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL in GetOAuthAuthorizationURL. |
| State | String | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Slack authorization server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| TeamName | String | The name of the current Slack team. |
| OAuthAccessToken | String | The access token used for communication with Slack. |
| TeamId | String | The ID of the current Slack team. |
| UserId | String | The ID of the current user. |
| OAuthRefreshToken | String | The refresh token used for communication with Slack. |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the auth token from this URL.
| Name | Type | Description |
| CallbackUrl | String | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the Slack app settings. |
| Scope | String | A comma-separated list of permissions to request from the user. Please check the Slack API for a list of available permissions. If not provided then the default scopes will be passed. For v2 the default scopes are: 'users.profile:read, channels:read, groups:read, im:read, mpim:read, channels:write, groups:write, im:write, mpim:write, channels:history, groups:history, im:history, mpim:history, search:read, files:read, pins:read, pins:write, usergroups:read, usergroups:write, reminders:read, reminders:write, users:read, users.profile:write, team.billing:read' and for openid the default scopes are 'openid profile email'. |
| State | String | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Slack authorization server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
Retrieve a permalink URL for a specific extant message.
| Name | Type | Description |
| ChannelId | String | The Id of the conversation or channel containing the message. |
| MessageId | String | A message's timestamp (ts) value, uniquely identifying it within a channel. |
| Name | Type | Description |
| Success | String | The result of the procedure. |
| ChannelId | String | The Id of the Channel. |
| PermaLink | String | The PermaLink URL of the message. |
Reads a workspace's billing plan information.
| Name | Type | Description |
| Success | String | The result of the procedure. |
| Plan | String | The workspace's billing plan. |
Invites users to a channel.
| Name | Type | Description |
| ChannelId | 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. |
| Name | Type | Description |
| Success | String | The result of the procedure. |
Joins an existing conversation.
| Name | Type | Description |
| ChannelId | String | The Id of the channel to join. |
| Name | Type | Description |
| Success | String | The result of the procedure. |
Joins the existing muliple channels.
Slack allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison.
For example:
EXECUTE JoinMultipleChannels
You can also specify the comma-separated names of the channels to join.
For example:
EXECUTE JoinMultipleChannels Channels = 'test*, *Slack*'
| Name | Type | Description |
| Channels | String | The comma-separated names of the channels to join. If not provided, by default, the user will join all the channels in which he has not yet joined. |
| Name | Type | Description |
| Success | String | The result of the procedure. |
Leaves a conversation.
| Name | Type | Description |
| ChannelId | String | Id of the conversation to leave. |
| Name | Type | Description |
| Success | String | The result of the procedure. |
Opens or resumes a direct message or multiperson direct message.
| Name | Type | Description |
| ChannelId | String | Resume a conversation by supplying an im or mpim's Id. Or, provide the Users field instead. |
| Users | String | Comma-separated lists of users. If only one user is included, this creates a 1:1 DM. Supply a channel when not supplying users. |
| Name | Type | Description |
| Success | String | The result of the procedure. |
Refresh an authentication token from Slack.
| Name | Type | Description |
| OAuthRefreshToken | String | The refresh token returned from Slack after the user has authorized your app to have access to their data.. |
| Name | Type | Description |
| OAuthAccessToken | String | The access token used for communication with Slack. |
| OAuthRefreshToken | String | The refresh token used for communication with Slack. |
| ExpiresIn | String | The time in which access token will expire. |
| TeamId | String | The ID of the current Slack team. |
| TeamName | String | The name of the current Slack team. |
| UserId | String | The ID of the current user. |
Deletes the authenticated user's profile photo.
| Name | Type | Description |
| Success | String | The result of the procedure. |
Sends an ephemeral message to a user in a channel.
Slack allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required scopes to execute this SP is chat:write, chat:write:user and chat:write:bot.
For example:
EXECUTE SendEphemeralMessage ChannelId = 'C01KWCPJJ68', UserId = 'U063F52GHED', Text = 'test message'
| Name | Type | Description |
| ChannelId | String | The Id of the conversation or channel containing the message. |
| UserId | String | The Id of the user who will receive the ephemeral message. |
| Text | String | The message that you want to send. |
| 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. |
| AsUser | Boolean | Set to true to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps. |
| IconEmoji | String | The emoji to use as the icon from this message. This overrides IconUrl. |
| IconUrl | String | The URL to an image to use as the icon for this message. |
| LinkNames | Boolean | Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead. |
| Parse | String | Change how messages are treated. Value should be either none or full.
The allowed values are none, full. |
| ParentMessageId | String | Provide another message's Id value to make this message a reply. Avoid using a reply's Id value; use its parent instead. |
| Username | String | The username of your bot. |
| Name | Type | Description |
| Success | String | The result of the procedure. |
| MessageId | String | The Id of the message sent. |
Schedules a message to be sent to a channel.
Slack allows only a subset of columns to be used in the Exec query. These columns can typically be used with the = comparison. The required scopes to execute this SP are chat:write, chat:write:user and chat:write:bot.
For example:
EXECUTE SendScheduleMessage Channel = 'D064Q184VGA', PostAt = '2024-07-27 08:20:27.0', Text = 'test message', ReplyBroadCast = true
| Name | Type | Description |
| Channel | String | Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. |
| PostAt | Datetime | The datetime representing the future time the message should post to Slack. |
| Text | String | The message that you want to send. |
| 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. |
| AsUser | Boolean | Set to true to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps. |
| LinkNames | Boolean | Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead. |
| Metadata | String | JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace. |
| Parse | String | Change how messages are treated. Value should be one of none or full.
The allowed values are none, full. |
| ReplyBroadCast | Boolean | Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false. |
| ParentMessageId | String | Provide another message's id value to make this message a reply. Avoid using a reply's id value; use its parent instead. |
| UnfurlLinks | Boolean | Pass true to enable unfurling of primarily text-based content. |
| UnfurlMedia | Boolean | Pass false to disable unfurling of media content. |
| Name | Type | Description |
| Success | String | The result of the procedure. |
Sets the read cursor in a channel.
| Name | Type | Description |
| ChannelId | String | Channel or conversation to set the read cursor for. |
| MessageId | String | Unique identifier of message you want marked as most recently seen in this conversation. |
| Name | Type | Description |
| Success | String | The result of the procedure. |
Turns on Do Not Disturb mode for the current user, or changes its duration.
| Name | Type | Description |
| NumOfMinutes | String | The number of minutes to snooze, starting now. |
| Name | Type | Description |
| Success | String | The result of the procedure. |
| SnoozeEnabled | String | Status whether snooze is enabled or not. |
| SnoozeEndTime | Datetime | The snooze End Time. |
| SnoozeRemaining | String | The remaining time of snooze, expressed in seconds. |
| SnoozeIsIndefinite | String | Indicates whether snooze is indefinite. |
To upload a file.
Slack allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required scopes to execute this SP are files:write, files:write:user and files:read.
For example:
EXECUTE UploadFile FullPath = 'D:\Desktop\Test.png', Size = '10', Title = 'Test title', ChannelId = 'D064Q184VGA'
Note: If you don't use the channel_id parameter, this only uploads the file — hosting the file in Slack — but doesn't share the file anywhere. Crucially, only the uploader will have access to the file if it is not shared anywhere. This SP will not support large files upload.
| Name | Type | Description |
| FileName | String | Name of the file being uploaded. |
| FullPath | String | The full path to the file to upload. |
| Size | Long | Size in bytes of the file being uploaded. |
| AltTxt | String | Description of image for screen-reader. |
| SnippetType | String | Syntax type of the snippet being uploaded. |
| Title | String | Title of the file. |
| ChannelId | String | Channel ID where the file will be shared. If not specified the file will be private. |
| InitialComment | String | The message text introducing the file in specified channels. |
| ThreadTs | String | Provide another message's timestamp (ts) value to upload this file as a reply. Never use a reply's ts value; use its parent instead. |
| Name | Type | Description |
| Success | String | The result of the procedure. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | The scheme used for authentication. Accepted entries are OAuth and UserToken. |
| OAuthVersion | The type of authentication to use when connecting to Slack. |
| UserToken | Set this to use the non-expiring user token created in Slack. Other types of token are also accepted. DEPRECATED: Use the Token Auth Scheme instead. |
| Token | The non-expiring token associated with your OAuth application. |
| ChannelAPIType | The API type of the channel used to retrieve channel-specific data;. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| ChannelType | The types of Channel to be returned when connecting to Slack. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Team | The name of the Slack Team. If you omit the optional Team parameter, you will be allowed to choose which workspace they are authenticating against. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UseSearch | Search Endpoint will be used for fetching the Channels. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AuthScheme | The scheme used for authentication. Accepted entries are OAuth and UserToken. |
| OAuthVersion | The type of authentication to use when connecting to Slack. |
| UserToken | Set this to use the non-expiring user token created in Slack. Other types of token are also accepted. DEPRECATED: Use the Token Auth Scheme instead. |
| Token | The non-expiring token associated with your OAuth application. |
| ChannelAPIType | The API type of the channel used to retrieve channel-specific data;. |
The scheme used for authentication. Accepted entries are OAuth and UserToken.
Use the following options to select your authentication scheme:
The type of authentication to use when connecting to Slack.
Set this to use the non-expiring user token created in Slack. Other types of token are also accepted. DEPRECATED: Use the Token Auth Scheme instead.
Set this to use the non-expiring user token created in Slack. Other types of token are also accepted. DEPRECATED: Use the Token Auth Scheme instead.
The non-expiring token associated with your OAuth application.
When you install an OAuth application to a workspace, as described in Creating a Custom OAuth Application, Slack generates a non-expiring OAuth token associated with the application. After installing the application, you can find the token value in your application's settings under Features > OAuth & Permissions > OAuth Tokens > User OAuth Token
You can authenticate to Slack using such tokens by setting the AuthScheme connection property to Token and setting this connection property to the value of the token.
This connection property supports the following token types:
Note: This connection property does not support tokens that have enabled token rotation, which allows tokens to expire and be refreshed. If you want the added security of enabling token rotation, use the "OAuth" authentication method, as documented in .
The API type of the channel used to retrieve channel-specific data;.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.
When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.
When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space- or colon-separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space- or colon-separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Slack. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Slack. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to Slack. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
Supported authentication types :
For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The username of a user registered with the proxy server. |
| DIGEST | The username of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\\CData\\Slack Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| ChannelType | The types of Channel to be returned when connecting to Slack. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Team | The name of the Slack Team. If you omit the optional Team parameter, you will be allowed to choose which workspace they are authenticating against. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UseSearch | Search Endpoint will be used for fetching the Channels. |
The types of Channel to be returned when connecting to Slack.
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.
| Property | Description |
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
The name of the Slack Team. If you omit the optional Team parameter, you will be allowed to choose which workspace they are authenticating against.
The name of the Slack Team. If you omit the optional Team parameter, you will be allowed to choose which workspace they are authenticating against.
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Channels WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
Search Endpoint will be used for fetching the Channels.
Deprecated: UseSearch Replacement: ChannelAPIType = AdminSearch The UseSearch property has been deprecated in favor of the more expressive ChannelAPIType property. When set to AdminSearch, ChannelAPIType performs the same function previously handled by UseSearch, with no change in behavior.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.