Skip to content

Commit

Permalink
Source Slack: add suggested streams (#30580)
Browse files Browse the repository at this point in the history
Co-authored-by: arsenlosenko <[email protected]>
  • Loading branch information
arsenlosenko and arsenlosenko authored Sep 28, 2023
1 parent 5eba3c3 commit 0183e31
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 22 deletions.
2 changes: 1 addition & 1 deletion airbyte-integrations/connectors/source-slack/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ COPY main.py ./
ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]

LABEL io.airbyte.version=0.3.2
LABEL io.airbyte.version=0.3.3
LABEL io.airbyte.name=airbyte/source-slack

Large diffs are not rendered by default.

9 changes: 8 additions & 1 deletion airbyte-integrations/connectors/source-slack/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ data:
connectorSubtype: api
connectorType: source
definitionId: c2281cee-86f9-4a86-bb48-d23286b4c7bd
dockerImageTag: 0.3.2
dockerImageTag: 0.3.3
dockerRepository: airbyte/source-slack
githubIssueLabel: source-slack
icon: slack.svg
Expand All @@ -17,6 +17,13 @@ data:
oss:
enabled: true
releaseStage: generally_available
suggestedStreams:
streams:
- users
- channels
- channel_messages
- channel_members
- threads
documentationUrl: https://docs.airbyte.com/integrations/sources/slack
tags:
- language:python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
"channel_id": {
"type": ["null", "string"]
},
"bot_id": {
"type": ["null", "string"]
},
"client_msg_id": {
"type": ["null", "string"]
},
Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/sources/slack.inapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
1. Enter a name for your connector
2. Select `Authenticate your Slack account` (preferred) and authorize into the Slack account. To use an API token instead, see the instructions below on creating one.
3. Toggle on **Join all channels** (recommended) to join all channels the user has access to or to sync data only from channels the app (if using API token) is already in. If false, you'll need to manually add all the channels from which you'd like to sync messages.
4. (Optional) Enter a **Threads Lookback Window (Days)** to set how far back to look for messages in threads from when each sync start.
5. (Optional) Enter a **Start Date**, enter the date in `YYYY-MM-DDTHH:mm:ssZ` format. Data created on and after this date will be replicated.
4. Enter a **Threads Lookback Window (Days)** to set how far back to look for messages in threads from when each sync start.
5. Enter a **Start Date**, enter the date in `YYYY-MM-DDTHH:mm:ssZ` format. Data created on and after this date will be replicated.
8. (Optional) Enter your `Channel name filter` to filter the list of channels Airbyte can access. If none are entered, Airbyte will sync all channels. It can be helpful to only sync required channels to avoid Slack's [requests limits](https://api.slack.com/docs/rate-limits).


Expand Down
18 changes: 10 additions & 8 deletions docs/integrations/sources/slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ This tutorial assumes that you are an administrator on your slack instance. If y
8. In Airbyte, create a Slack source. The "Bot User OAuth Access Token" from the earlier should be used as the token.
9. You can now pull data from your slack instance!


<!-- env:oss -->
**Airbyte Open Source additional setup steps**

Expand All @@ -76,10 +77,10 @@ We recommend creating a restricted, read-only key specifically for Airbyte acces
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**.
3. On the Set up the source page, enter the name for the Slack connector and select **Slack** from the Source type dropdown.
4. Select `Authenticate your account` and log in and Authorize to the Slack account.
5. Enter your `start_date`.
6. Enter your `lookback_window`.
7. Enter your `join_channels`.
8. Enter your `channel_filter`.
5. **Required** Enter your `start_date`.
6. **Required** Enter your `lookback_window`, which corresponds to amount of days in the past from which you want to sync data.
7. Toggle `join_channels`, if you want to join all channels or to sync data only from channels the bot is already in. If not set, you'll need to manually add the bot to all the channels from which you'd like to sync messages.
8. Enter your `channel_filter`, this should be list of channel names (without leading '#' char) that limits the channels from which you'd like to sync. If no channels are specified, Airbyte will replicate all data.
9. Click **Set up source**.
<!-- /env:cloud -->

Expand All @@ -88,10 +89,10 @@ We recommend creating a restricted, read-only key specifically for Airbyte acces

1. Navigate to the Airbyte Open Source dashboard.
2. Set the name for your source.
3. Enter your `start_date`.
4. Enter your `lookback_window`.
5. Enter your `join_channels`.
6. Enter your `channel_filter`.
3. **Required** Enter your `start_date`.
4. **Required** Enter your `lookback_window`, which corresponds to amount of days in the past from which you want to sync data.
5. Toggle `join_channels`, if you want to join all channels or to sync data only from channels the bot is already in. If not set, you'll need to manually add the bot to all the channels from which you'd like to sync messages.
6. Enter your `channel_filter`, this should be list of channel names (without leading '#' char) that limits the channels from which you'd like to sync. If no channels are specified, Airbyte will replicate all data.
7. Enter your `api_token`.
8. Click **Set up source**.
<!-- /env:oss -->
Expand Down Expand Up @@ -136,6 +137,7 @@ It is recommended to sync required channels only, this can be done by specifying

| Version | Date | Pull Request | Subject |
|:--------|:-----------|:---------------------------------------------------------|:------------------------------------------------------------------------------------|
| 0.3.3 | 2023-09-28 | [30580](https://github.com/airbytehq/airbyte/pull/30580) | Add `bot_id` field to threads schema |
| 0.3.2 | 2023-09-20 | [30613](https://github.com/airbytehq/airbyte/pull/30613) | Set default value for channel_filters during discover |
| 0.3.1 | 2023-09-19 | [30570](https://github.com/airbytehq/airbyte/pull/30570) | Use default availability strategy |
| 0.3.0 | 2023-09-18 | [30521](https://github.com/airbytehq/airbyte/pull/30521) | Add unexpected fields to streams `channel_messages`, `channels`, `threads`, `users` |
Expand Down

0 comments on commit 0183e31

Please sign in to comment.