Skip to content

Latest commit

 

History

History
129 lines (88 loc) · 6.17 KB

slack.md

File metadata and controls

129 lines (88 loc) · 6.17 KB
Raw

Slack

Sync overview

This source can sync data for the Slack API. It supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run.

Output schema

This Source is capable of syncing the following core Streams:

Data type mapping

Integration Type Airbyte Type Notes
string string
number number
array array
object object

Features

Feature Supported?(Yes/No) Notes
Full Refresh Sync Yes
Incremental Sync Yes
Namespaces No

Performance considerations

The connector is restricted by normal Slack requests limitation.

It is recommended to sync required channels only, this can be done by specifying config variable channel_filter in settings.

The Slack connector should not run into Slack API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.

Getting started

Requirements

Slack connector can be connected using two types of authentication: OAuth2.0 or API Token

Using OAuth2.0 authenticator

  • Client ID - issued when you created your app
  • Client Secret - issued when you created your app
  • Refresh Token - a special kind of token used to obtain a renewed access token

You can get more detailed information about this type of authentication by reading Slack's documentation about OAuth2.0.

Using API Token

  • Slack API Token

Setup guide

:::info

If you are using an "legacy" Slack API, skip to the Legacy API Key section below.

:::

In order to pull data out of your Slack instance, you need to create a Slack App. This may sound daunting, but it is actually pretty straight forward. Slack supplies documentation on how to build apps. Feel free to follow that if you want to do something fancy. We'll describe the steps we followed to creat the Slack App for this tutorial.

:::info

This tutorial assumes that you are an administrator on your slack instance. If you are not, you will need to coordinate with your administrator on the steps that require setting permissions for your app.

:::

  1. Go to the apps page

  2. Click "Create New App"

  3. It will request a name and the slack instance you want to create the app for. Make sure you select the instance form which you want to pull data.

  4. Completing that form will take you to the "Basic Information" page for your app.

  5. Now we need to grant the correct permissions to the app. (This is the part that requires you to be an administrator). Go to "Permissions". Then under "Bot Token Scopes" click on "Add an OAuth Scope". We will now need to add the following scopes:

     channels:history
 channels:join
 channels:read
 files:read
 groups:read
 links:read
 reactions:read
 remote_files:read
 team:read
 usergroups:read
 users.profile:read
 users:read

    This may look daunting, but the search functionality in the dropdown should make this part go pretty quick.

  6. Scroll to the top of the page and click "Install to Workspace". This will generate a "Bot User OAuth Access Token". We will need this in a moment.

  7. Now go to your slack instance. For any public channel go to info => more => add apps. In the search bar search for the name of your app. (If using the desktop version of slack, you may need to restart Slack for it to pick up the new app). Airbyte will only replicate messages from channels that the Slack bot has been added to.

  8. In Airbyte, create a Slack source. The "Bot User OAuth Access Token" from the earlier should be used as the token.

  9. You can now pull data from your slack instance!

Setup guide (Legacy API Key)

You can no longer create "Legacy" API Keys, but if you already have one, you can use it with this source. Fill it into the API key section.

We recommend creating a restricted, read-only key specifically for Airbyte access. This will allow you to control which resources Airbyte should be able to access.

Changelog

Version Date Pull Request Subject
0.1.15 2022-03-31 11613 Add 'channel_filter' config and improve performance
0.1.14 2022-01-26 9575 Correct schema
0.1.13 2021-11-08 7499 Remove base-python dependencies
0.1.12 2021-10-07 6570 Implement OAuth support with OAuth authenticator
0.1.11 2021-08-27 5830 Fixed sync operations hang forever issue
0.1.10 2021-08-27 5697 Fixed max retries issue
0.1.9 2021-07-20 4860 Fixed reading threads issue
0.1.8 2021-07-14 4683 Add float_ts primary key
0.1.7 2021-06-25 3978 Release Slack CDK Connector