https://github.com/phuurl/slack-channel-inviter

Workflow to invite the calling user to a set of channels
https://github.com/phuurl/slack-channel-inviter

slack slack-new-platform slack-workflow

Last synced: 4 days ago
JSON representation

Workflow to invite the calling user to a set of channels

• Host: GitHub
• URL: https://github.com/phuurl/slack-channel-inviter
• Owner: Phuurl
• License: mit
• Created: 2023-05-27T21:23:28.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-25T17:29:13.000Z (11 months ago)
• Last Synced: 2023-12-25T20:02:41.773Z (11 months ago)
• Topics: slack, slack-new-platform, slack-workflow
• Language: TypeScript
• Homepage:
• Size: 425 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Slack Channel Inviter

This workflow will add the calling user to a predefined set of channels.

## Installation

This app uses the [new Slack platform](https://api.slack.com/future), meaning everything is hosted within Slack - so no cloud resources or other hosting is required.

To deploy the workflow, follow these steps:

1. Install and configure the [Slack CLI](https://api.slack.com/automation/cli/install)

1. Replace the placeholder channel IDs in [`channels.ts`](./channels.ts) with the IDs of the channels you want the workflow to invite users to

    - If you don't already have the [Slack Developer Tools](https://sdt.builtbyslack.com/) app installed, it's an easy way of gathering channel IDs. They can also be found in a channels' details view.

1. Deploy the app to the Slack Platform with `slack deploy`, creating the trigger when prompted

1. Take the trigger URL outputted by the Slack CLI, and send that in the relevant place for your users

    - That could be just sending it in channel, adding it as a channel bookmark, or placing it in a Canvas

1. Invite the app to the _source_ channel of the workflow invocations with `/invite @Channel Inviter`

## Usage

Once installed, users can execute the workflow with the link provided as above, and will then be added to the specified channels.

![Workflow preview](./.github/img/workflow.png)

## Limitations

- The app must be added to the channel that users trigger the workflow from, otherwise executions will fail

- The user installing the app via `slack deploy` must be present in the target channel(s), and have invite permissions