at-channel is a Slack integration that allows admins to turn off their @channel permissions in a Slack workspace, while allowing a team of admins and moderators to approve or reject requests from any member.
The integration allows members to request messages by typing /channel <message here>. If the request is made from a locked channel (found in handlers/slashCommands.js), the request is put through to the #at-channel-requests channel, where moderators can review it.
So, as said, if a /channel request is made from a non-open channel, a request is sent to the mods' channel for review. An ephemeral message is sent to the requesting user at the location of their request saying "Thanks!," and a direct message is sent to them, as well. This DM allows the requester to cancel their request, which notifies the mods' channel accordingly.
If, though, the request is placed in an open channel, it is immediately sent to the channel—no ephemeral messages, cancellation options, or request-for-approval placed.
To gain permissions to review /channel requests, a user must be a part of the @admins or @mods Slack user group for their particular workspace. By default, admins can approve all requests, while mods can approve all but their own. Collectively, we call the entire review team "moderators" or "mods," though programatically, they are different roles.
at-channel was designed for transparency, and we suggest keeping #at-channel-requests as an open channel. All previous requests are saved as messages, and it is noted who sent a particular request, as well as which moderator approved or denied the request.
Setting up at-channel is pretty easy, requiring a few things configured on Slack, and a few environment variables set on your server's side.
Head over to Slack's app portal and create a new app. You're going to want to make sure you set up "interactive components" as well as "slash commands." Furthermore, we use OAuth tokens for authentication; make sure your app has bot, commands, and usergroups:read scopes before installing the app to your workspace.
Using what you just set up on Slack, you now need to set up the server's environment variables. At this point, you should've cloned this repo to your server and run npm i to get all the packages squared away. Next, copy or rename the .env.example file to .env, and open it up. Fill out the fields accordingly (you will need a bunch of the information from Slack's app portal). When that's done, running nodemon server.js or running the server in whatever other way you choose should work!
To regenerate jsdoc files use:
jsdoc -R README.md -d docs/ handlers/*.js utilities/*.js server.js
at-channel is provided under the MIT License.
For any question, comments, or concerns, email [email protected], create an issue, or open up a pull request.