Skip to main content

Slack

This connector captures data from Slack into Flow collections.

It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-slack:dev provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.

This connector is based on an open-source connector from a third party, with modifications for performance in the Flow system. You can find their documentation here, but keep in mind that the two versions may be significantly different.

Supported data resources

The following data resources are supported through the Slack APIs:

By default, each resource is mapped to a Flow collection through a separate binding.

Prerequisites

  • Slack workspace URL or API token for authentication.

Configuration

You configure connectors either in the Flow web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the Slack source connector.

Properties

Endpoint

PropertyTitleDescriptionTypeRequired/Default
/join_channelsJoin ChannelsWhether to join all channelsbooleantrue
/lookback_windowThreads Lookback window (Days)How far into the past to look for messages in threads.integerRequired
/start_dateStart DateUTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated.stringRequired

Bindings

PropertyTitleDescriptionTypeRequired/Default
/streamStreamResource of your Slack project from which collections are captured.stringRequired
/syncModeSync ModeConnection method.stringRequired

Sample


captures:
${PREFIX}/${CAPTURE_NAME}:
endpoint:
connector:
image: ghcr.io/estuary/source-slack:dev
config:
credentials:
auth_type: OAuth
access_token: {secret}
client_id: {your_client_id}
client_secret: {secret}
join_channels: true
lookback_window: 7
start_date: 2017-01-25T00:00:00Z
bindings:
- resource:
stream: channel_members
syncMode: full_refresh
target: ${PREFIX}/channel_members
{...}