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.
This Source Connector is based on a Singer Tap.
This Source is capable of syncing the following core Streams:
Messages (Conversation History) It will only replicate messages from non-archive, public channels that the Slack App is a member of.
Full Refresh Sync
The connector is restricted by normal Slack requests limitation.
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.
Slack API Token
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.
Go to the apps page
Click "Create New App"
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.
Completing that form will take you to the "Basic Information" page for your app.
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:
This may look daunting, but the search functionality in the dropdown should make this part go pretty quick.
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.
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.
In Airbyte, create a Slack source. The "Bot User OAuth Access Token" from the earlier should be used as the token.
You can now pull data from your slack instance!
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.