The tap-slack Singer tap pulls data from Slack that can then be sent to a destination using a Singer target.

Alternative variants #

Multiple variants of tap-slack are available. This document describes the default mashey variant, which is recommended for new users.

Alternative variants are:

Standalone usage #

Install the package using pip:

pip install git+https://github.com/Mashey/tap-slack.git

For additional instructions, refer to the README in the repository.

Usage with Meltano #

Meltano helps you manage your configuration, incremental replication, and scheduled pipelines.

View the Meltano-specific tap-slack instructions to learn more.

Capabilities #

These capabilities can also be overriden by specifying the capabilities key in your meltano.yml file.

Settings #

The settings for tap tap-slack that are known to Meltano are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

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

API Token (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:history
  • channels:join
  • channels:read
  • files:read
  • groups:read
  • links:read
  • reactions:read
  • remote_files:read
  • remote_files:write
  • team:read
  • usergroups:read
  • users.profile:read
  • users:read

Sync Start Date (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) #

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

  • Default: true

Specifies whether to sync private channels or not. Default is true.

Join Public Channels (join_public_channels) #

  • Default: false

Specifies whether to have the tap auto-join all public channels in your ogranziation. Default is false.

Sync Archived Channels (archived_channels) #

  • Default: 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) #

  • Default: 7

Specifies the window size for syncing certain streams (messages, files, threads). The default is 7 days.

Looking for help? #

If you're having trouble getting the tap-slack tap to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!