 | Slack
Team communication tool |
The tap-slack Meltano extractor pulls data from Slack that can then be sent to a destination using a loader.
Other Available Variants
- envoy
- mashey (default)
- meltanolabs
- richard-clark
- transferwise
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-slack extractor to your project
using
:meltano add -
Configure the tap-slack settings using
:meltano config -
Test that extractor settings are valid using
:meltano test
meltano add extractor tap-slackmeltano config tap-slack set --interactivemeltano test tap-slackNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities fortap-slackThis plugin has the following capabilities:
- catalog
- discover
- state
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-slack settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
API Token (token)
-
Environment variable:
TAP_SLACK_TOKEN
Your Slack API Token. To obtain a token for a single workspace you will need to create a Slack App in your workspace and assigning it the relevant scopes. The minimum required scopes for the tap are:
channels:historychannels:joinchannels:readfiles:readgroups:readlinks:readreactions:readremote_files:readremote_files:writeteam:readusergroups:readusers.profile:readusers:read
Sync Start Date (start_date)
-
Environment variable:
TAP_SLACK_START_DATE
Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.
Channels to Sync (channels)
-
Environment variable:
TAP_SLACK_CHANNELS
Optionally specify specific channels to sync. By default the tap will sync all channels it has been invited to, but this can be overriden to limit it ot specific channels. Note this needs to be channel ID, not the name, as recommended by the Slack API. To get the ID for a channel, either use the Slack API or find it in the URL.
Join Private Channels (private_channels)
-
Environment variable:
TAP_SLACK_PRIVATE_CHANNELS -
Default Value:
true
Specifies whether to sync private channels or not. Default is true.
Join Public Channels (join_public_channels)
-
Environment variable:
TAP_SLACK_JOIN_PUBLIC_CHANNELS -
Default Value:
false
Specifies whether to have the tap auto-join all public channels in your ogranziation. Default is false.
Sync Archived Channels (archived_channels)
-
Environment variable:
TAP_SLACK_ARCHIVED_CHANNELS -
Default Value:
false
Specifies whether the tap will sync archived channels or not. Note that a bot cannot join an archived channel, so unless the bot was added to the channel prior to it being archived it will not be able to sync the data from that channel. Default is false.
Date Window Size (date_window_size)
-
Environment variable:
TAP_SLACK_DATE_WINDOW_SIZE -
Default Value:
7
Specifies the window size for syncing certain streams (messages, files, threads). The default is 7 days.
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-generalInstall
meltano add extractor tap-slackHomepage
Maintenance Status
-brightgreen){kind=icon}
Maintainer
Meltano Stats
-42-c0c0c4){kind=icon}
-12-c0c0c4){kind=icon}
Keywords
