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 mashey variant.

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

Install Meltano, create your Meltano project, and add the tap to your project as an extractor:

meltano add extractor tap-slack --variant mashey

For additional instructions, refer to the Meltano-specific documentation for tap-slack.

Capabilities

Settings

API Token (api_token)

See https://support.zendesk.com/hc/en-us/articles/226022787-Generating-a-new-API-token-.

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)

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)

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

Join Public Channels (join_public_channels)

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

Sync Archived Channels (archived_channels)

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)

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 tap-slack to work by itself or with Meltano, 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! It is also validated against a JSON Schema used for taps and targets.


Edit this page on GitLab!