 | 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-slack --variant meltanolabsmeltano 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
- state
- discover
- about
- stream-maps
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:
api_keystart_datethread_lookback_dayschannel_typesauto_join_channelsselected_channelsexcluded_channels
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 Key (api_key)
-
Environment variable:
TAP_SLACK_API_KEY
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.
Thread Lookback Days (thread_lookback_days)
-
Environment variable:
TAP_SLACK_THREAD_LOOKBACK_DAYS
The number of days to look in the past for new thread replies to existing messages
Channel Types (channel_types)
-
Environment variable:
TAP_SLACK_CHANNEL_TYPES
The types of conversations the tap will attempt to extract data from. Must be one of 'public_channel', 'mpim', 'private_channel', or 'im'. Note that the Slack app must have the appropriate privileges and be a member of the conversations to sync messages.
Auto Join Channels (auto_join_channels)
-
Environment variable:
TAP_SLACK_AUTO_JOIN_CHANNELS
Whether the bot user should attempt to join channels that it has not yet joined. The bot user must be a member of the channel to retrieve messages.
Selected Channels (selected_channels)
-
Environment variable:
TAP_SLACK_SELECTED_CHANNELS
A list of channel IDs that should be retrieved. If not defined then all are selected.
Excluded Channels (excluded_channels)
-
Environment variable:
TAP_SLACK_EXCLUDED_CHANNELS
A list of channel IDs that should not be retrieved. Excluding overrides a selected setting, so if a channel is included in both selected and excluded, it will be excluded.
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-slack --variant meltanolabsMaintenance Status
-brightgreen){kind=icon}
Maintainer
Meltano Stats
-4-c0c0c4){kind=icon}
-4-c0c0c4){kind=icon}
Keywords
