Adding a Connection to Slack

To add a connection to Slack:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Slack icon is not available, click the Add More icon to download and install the Slack connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Slack

The Sync App supports the following authentication mechanisms:

• OAuth (Slack's "V2" implementation of OAuth 2.0 and OAuth via OpenId Connect are supported)
• user token authentication

OAuth

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.

• Set OAuthVersion to v2 for Modern Slack apps.
• Set OAuthVersion to openid for Slack apps using "Sign in with Slack".

Before you connect, set the following variables:

• OAuthClientId: The client Id assigned when you registered your custom OAuth application.
• OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

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:

• Extracts the access token from the callback URL.
• Obtains a new access token when the old one expires.
• Saves OAuth values so that they persist across connections.

User Token

After Creating a Custom OAuth Application and selecting scopes, as an alternative to configuring the standard OAuth credentials (client, client secret, and callback URL), you can use a User OAuth Token to authenticate.

To use a token, set AuthScheme to UserToken and set UserToken to the value of the "User OAuth Token", found in your app settings in Features > OAuth & Permissions.

Required Scopes and Endpoint Domains for Slack

When integrating with Slack, your application needs specific permissions to interact with the API.

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.

Understanding Scopes

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.

Required Scopes for Slack

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.

Understanding Endpoint Domains

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.

Required Endpoint Domains for Slack

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.

User Defined Views

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 .

SSL Configuration

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" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Slack and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Customizing the SSL Configuration

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.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

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.

Slack Connector for CData Sync Tables

Name	Description
Bookmarks	Retrieves the list of bookmarks for the channel.
Calls	Register,update,end 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.

Select

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' 

Insert

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')

Update

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'

Delete

Bookmarks can be deleted by providing the ChannelId and the Id of the Bookmark.

DELETE FROM Bookmarks WHERE ChannelId = 'D71R6CSR1' AND Id = 'Bk0871NJJQD8' 

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the bookmark
ChannelId	String	True	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.
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-Columns

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,end or return information about a Call.

Select

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'

Insert

Inserts are allowed when you specify the ExternalUniqueId and JoinURL. For example:

INSERT INTO Calls (ExternalUniqueId, JoinURL) VALUES (uniqId, joinurl)

Update

Updates are allowed when you specify the Id.

UPDATE Calls SET JoinURL = 'join', Title = 't' WHERE Id = 'R04HH525YBS'

Delete

Slack does not allow Calls to be deleted.

Columns

Name	Type	ReadOnly	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.

Select

The Sync App will use the Slack API to process search criteria that refer to the Id, IsArchived, IsPublic, IsGroup, 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 IsGroup = false AND IsArchived = true
 SELECT * FROM Channels WHERE Id = 'D71R6CSR1' 
 SELECT * FROM Channels WHERE User = 'U03AZBU3CMT' 

Insert

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)

Update

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' 

Delete

Slack does not allow Channels to be deleted.

Columns

Name	Type	ReadOnly	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	Creator of the channel topic.
Purpose	String	False	Information about the channel purpose.
TotalMembers	Integer	True	Number of members in the channel.
Created	Datetime	True	Channel creation datetime.
Creator	String	True	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 the user or bot user or Slack app associated with the token making the API call is itself a member of the conversation.
IsArchived	Boolean	True	Indicates a conversation is archived. Frozen in time
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	Means 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	Means 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	Normalized name of the channel.
IsShared	Boolean	True	Means the conversation is in some way shared between multiple workspaces.
IsExtShared	Boolean	True	Represents this conversation as being part of a Shared Channel with a remote organization.
IsOrgShared	Boolean	True	Explains whether this shared channel is shared between Enterprise Grid workspaces within the same organization.
IsPendingExtShared	Boolean	True	It means the conversation is ready to become an IsExtShared channel but isn't quite ready yet and needs some kind of approval or sign off.
PreviousNames	String	True	A list of previous names this channel has had.
Locale	String	True	Locale of the channel.
User	String	True	Id of the user.
IsUserDeleted	Boolean	True
Priority	String	True

Pseudo-Columns

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

Retrieve members of a conversation.

Select

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'

Delete

Members can be removed from the conversation by specifying the ChannelId and MemberId.

DELETE FROM ConversationMembers WHERE ChannelId = 'D71R6CSR1' AND MemberId = 'U03AZBU3CMT' 

Columns

Name	Type	ReadOnly	Description
MemberId	String	True	ID of the member.
ChannelId	String	True	ID of the conversation to retrieve members for.

Query and delete team files.

Select

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'

Insert

Slack does not allow inserting new files.

Update

Slack does not allow updating files.

Delete

Files can be deleted by providing the Id of the file.

DELETE FROM Files WHERE Id = 'F71R6DRR1'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the file.
Name	String	True	The name of the file. It may nbe null for unnamed files
Title	String	True	The title of the file.
Created	Datetime	True	Creation date of the file.
UserId	String	True	User ID of the member that created this file.
Username	String	True	Username of the file creator.
InitialComment	String	True	A comment from the file uploader, and will only be 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	Mime type of the file.
PrettyType	String	True	Human-readable version of the type.
CommentsCount	Integer	True	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 that files are stored in editable mode.
Permalink	String	True	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	Present for posts and snippets. The page where the file can be edited
UrlPrivate	String	True	Points to a URL to the file contents.
UrlPrivateDownload	String	True	For editable-mode files, this parameter includes headers to force a browser download.
Thumb480	String	True	Contains the URL of an 480x480 thumb.

Pseudo-Columns

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,zips. 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.

Table Specific Information

Select

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.

• ChannelId supports the = operator.
• ParentMessageId supports the = operator.
• CreatedTime supports the <,>,>=,<=,= operator.
• ParentCreatedTime supports the <,>,>=,<=,= operator.

For example, the following query is processed server side:

SELECT * FROM MessageReplies WHERE ChannelId = 'D71R6CSR1' AND ParentMessageId = '1234567890.123456'

Insert

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')

Update

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' 

Delete

MessageReplies can be deleted by providing the ChannelId and the Id of the message.

DELETE FROM MessageReplies WHERE ChannelId = 'D71R6CSR1' AND Id = '1234567890.123456 

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Unique identifier for the messages.
ChannelId [KEY]	String	False	Conversation ID to fetch thread from.
UserId	String	True	User Id of the user who posted the reply.
Text	String	False	Reply message content.
ParentMessageId [KEY]	String	False	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.

Table Specific Information

Select

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.

• ChannelId supports the = operator.
• SearchTerm supports the = operator.
• CreatedTime supports the <,>,>=,<=,= operator.

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' 

Insert

Slack allows inserts only when ChannelId and Text are specified.

INSERT INTO Messages (ChannelId, Text) VALUES ('D71R6CSR1', 'This is a message')

Update

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' 

Delete

Messages can be deleted by providing the ChannelId and the Id of the message.

DELETE FROM Messages WHERE ChannelId = 'D71R6CSR1' AND Id = '1234567890.123456' 

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the message.
ChannelId [KEY]	String	False	The Id of the channel the message was posted to.
UserId	String	True	The Id of the user that posted the message.
Text	String	False	Text of the message.
Type	String	True	Type of the message.
Item_type	String	True	Item type of the message.
Subtype	String	True	Subtype of the message.
Team	String	True	Team of the message.
Pinned_to	String	False	Pinned details of the message.
Pinned_info_Channel	String	True	Id of the pinned channel of the message.
Pinned_info_pinned_by	String	True	Id of the pinned by message.
Pinned_info_pinned_ts	String	True	Id of the pinned message of the message.
AttachmentsAggregate	String	True	Attachments made to the message.
Purpose	String	False	Purpose of the message.
BotId	String	True	BotId of the message.
BotLink	String	True	BotLink of the message.
Username	String	True	UserName of the message.
Reply_count	Integer	False	Count of the replied channels to the message.
Reply_users_count	Integer	False	Count of the replied users to the message.
Latest_reply	String	True	Latest message reply of the message.
Last_read	String	True	Last read message.
Reply_usersAggreagte	String	True	Replied user details of the message.
Subscribed	Boolean	True	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.

Create, delete, and query all items pinned to a channel.

Select

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'

Insert

INSERTS are allowed when you specify the ChannelId and Id. For example:

INSERT INTO Pins (ChannelId, Id) VALUES ('D71R6CSR1', 'F71R6DRR1')

Update

Slack does not support UPDATE for pins.

Delete

You can delete a pin by providing the ChannelId and Id.

DELETE FROM Pins WHERE ChannelId = 'D71R6CSR1' AND Id = '1505287261.000226'

Columns

Name	Type	ReadOnly	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	Channel Id to get pinned items for.
PinnedToChannelIds	String	True	Comma separated list of channel ids the item is pinned to.
CreatedBy	String	True	The encoded user id of the user who pinned the item.

Create, delete, and query reactions on items.

Select

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' 

Insert

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')

Update

Slack does not support UPDATE for reactions.

Delete

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'

Columns

Name	Type	ReadOnly	Description
Id	String	False	The Id of the reacted item.
ChannelId	String	False	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 name of the reaction

Create, delete, and query all reminders by or for a given user.

Select

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'

Insert

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 Frequency column.

INSERT INTO Reminders (Text, Frequency, UserId) VALUES ('Remind me for coffee', 'every_tuesday', 'U723764DF')

Update

Slack does not support UPDATE for reminders.

Delete

You can delete a reminder by providing the Id.

DELETE FROM Reminders WHERE Id = 'R71R6CSR1'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the reminder.
Creator	String	True	The Id of the user who created the reminder.
UserId	String	False	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.

Select

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'

Delete

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' 

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the scheduled message.
ChannelId	String	True	The Id of the Channel.
PostAt	Datetime	True	The posted date
CreatedTime	Datetime	True	The created date.
Text	String	True	Text of the scheduled message.

Pseudo-Columns

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	Id of the user.

Create, update, and query all User Groups for a Slack team.

Select

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'

Insert

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')

Update

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'

Delete

Slack does not support the deletion of user groups.

Columns

Name	Type	ReadOnly	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	Id of the user who created the user group.
UpdatedBy	String	True	Id of the user who last modified the user group.
DeletedBy	String	True	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-Columns

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.

Select

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');

Insert

Slack does not support inserting new users.

Update

There are a number of requirements for updating the user profile:

• Workspace must be on a paid plan to update the profile value for other users.
• Must select “API” as the “Data source” within the Configure Profiles admin tool.
• This operation requires to use a user access token (Not a bot token) that is users.profile:write.
• Org users cannot change their own profile details.
• You cannot change the profile details for another user unless you use a token that was generated by an Owner or Admin.
• You also can only change the profile details for a user if your role level is higher than theirs.

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';

Delete

Slack does not support deleting users.

Columns

Name	Type	ReadOnly	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.
Email	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-Columns

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.

Select

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'

Insert

Slack does not support inserting new users.

Update

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'

Delete

Slack does not support deleting users.

Columns

Name	Type	ReadOnly	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.

Slack Connector for CData Sync Views

Name	Description
Dnd	Retrieves a user's current Do Not Disturb status.
Team	Gets 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.

Select

The Sync App processes filters client-side within the Sync App.

For example, the following query is processed server side:

SELECT * FROM Dnd

Columns

Name	Type	Description
DndEnabled	Boolean	DND status of the user
NextDndEndTs	Datetime	Time when DND starts
NextDndStartTs	Datetime	Time when DND ends
SnoozeEnabled	Boolean	Snooze status of the User. Visible only if the user is current user.
SnoozeEndtime	Datetime	Time when snooze ends. Visible only if the user is current user.
SnoozeIsIndefinite	Boolean	Indicates snooze will not automatically end. Visible only if the user is current user.
SnoozeRemaining	Datetime	Time remaining till snooze ends. Visible only if the user is current user.

Gets information about the current team.

Select

The Sync App will use the Slack API to filter by search criteria that refer to the Id column. The column support server-side processing for the = operator.

The Sync App processes filters client-side within the Sync App.

For example, the following query is processed server side:

SELECT * FROM Team

SELECT * FROM Team WHERE Id = 'T01LC4ASB2M'

Columns

Name	Type	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.

Select

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.

• TeamId supports the = operator.

For example, the following query is processed server side:

SELECT * FROM TeamAccessLogs WHERE TeamId = 'T01LC4ASB3M'

Columns

Name	Type	Description
TeamId [KEY]	String	Id of the team.
UserId	String	Id of the user.
Username	String	Username of the user.
DateFirst	Datetime	The first login date time.
DateLast	Datetime	The last login date time.
Count	Integer	The login count.
IP	String	IP address of the user.
UserAgent	String	The user agent with which user logged in.
Isp	String	The internet service provider.
Country	String	Country.
Region	String	Region.

Retrieves the Do Not Disturb status for up to 50 users on a team.

Select

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 User column in the WHERE clause; otherwise, the driver will automatically add the column.

• User supports the =,IN operator.

For example, the following query is processed server side:

SELECT * FROM TeamInfo WHERE User = 'U01KZFNNTPC'

SELECT * FROM TeamInfo WHERE User IN ('U01KZFNNTPC','U04QTH44D9S')

Columns

Name	Type	Description
User	String	The Id of the user.
DndEnabled	Boolean	Indicates whether DND is enabled.
NextDndStartTime	Datetime	Next DND Start time.
NextDndEndTime	Datetime	Next DND End time.

Retrieves a team profile's Fields

Select

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.

• IsHidden supports the = operator.

For example, the following query is processed server side:

SELECT * FROM TeamProfileFields

SELECT * FROM TeamProfileFields WHERE IsHidden = false

Columns

Name	Type	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

Select

The Sync App processes filters client-side within the Sync App.

For example, the following query is processed server side:

SELECT * FROM TeamProfileSections

Columns

Name	Type	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.

Select

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')

Columns

Name	Type	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.

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.

Authentication

---

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.

OAuth

---

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

SSL

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

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.

Proxy

---

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	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) 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	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

---

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.

Schema

---

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 .

Miscellaneous

---

Property	Description
ChannelType	The types of Channel to be returned when connecting to Slack.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
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. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

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.

The scheme used for authentication. Accepted entries are OAuth and UserToken.

Remarks

Use the following options to select your authentication scheme:

• OAuth: Set to this to perform OAuth authentication.
• UserToken: Set to this to perform UserToken authentication.

The type of authentication to use when connecting to Slack.

Remarks

• v2: Set to this to perform OAuth authentication on new applications.
• openid: Set to this to perform OAuth authentication using OpenId Connect.

Set this to use the non-expiring user token created in Slack.

Remarks

Set this to use the non-expiring user token created in Slack.

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 that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

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.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is 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

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

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.

Remarks

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.

Remarks

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.

Remarks

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.

Remarks

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.

Remarks

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	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) 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	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	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.

Remarks

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. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

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, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is 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.

Remarks

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NTLM: The Sync App retrieves an NTLM token.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• NONE: Set this when the ProxyServer does not require authentication.

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.

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

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 user name of a user registered with the proxy server.
DIGEST	The user name 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.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

The password associated with the user specified in the ProxyUser connection property.

Remarks

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.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

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.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that 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.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

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.

Remarks

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 .

Remarks

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 .

Remarks

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 .

Remarks

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 rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
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. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

The types of Channel to be returned when connecting to Slack.

Remarks

• all: Set to this to retrieve all the channels.
• public: Set to this to retrieve public channels.
• private: Set to this to retrieve Private channels.
• im: Set to this to retrieve Direct Message channels.
• mpim: Set to this to retrieve MultipartyDirectMessage channels.

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in 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.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

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.

Remarks

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 default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

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.

Setting this property to 0 disables the timeout, allowing 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. 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 defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property 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 define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.