https://github.com/tdmalone/slack-topic-updater

Updates a Slack channel's topic, hiding the 'topic update' notice.
https://github.com/tdmalone/slack-topic-updater

node-js nodejs slack

Last synced: about 13 hours ago
JSON representation

Updates a Slack channel's topic, hiding the 'topic update' notice.

• Host: GitHub
• URL: https://github.com/tdmalone/slack-topic-updater
• Owner: tdmalone
• License: mit
• Archived: true
• Created: 2018-09-29T06:11:36.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T14:27:20.000Z (almost 2 years ago)
• Last Synced: 2024-09-08T13:42:15.635Z (17 days ago)
• Topics: node-js, nodejs, slack
• Language: JavaScript
• Size: 593 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Slack Topic Updater

Updates a Slack channel's topic, then 'hides' the topic update notice by deleting it afterwards. Useful for regular scripted updates of a channel's topic.

## Why?

Updating a Slack channel topic is pretty simple. But, it leaves a message behind saying the topic has been updated. If you want to automate topic updates - for example, to use them as a 'ticker' of sorts - this can result in a lot of useless noise.

So, this module abstracts into one line the process of checking the current topic, querying the latest channel messages, and then deleting the topic update message. All this happens quite quickly, so no-one will notice the topic update message appearing unless they're watching quite intently!

As a bonus, the same topic text can be sent to multiple channels at the same time.

## Usage

Add to your project:

    npm install --save slack-topic-updater

Or if you use [Yarn](https://yarnpkg.com/):

    yarn add slack-topic-updater

Then, call like this:

    const slackTopicUpdater = require('slack-topic-updater');

    const response = await slackTopicUpdater.update({

      token: 'xoxp-0000000000-000000000000-000000000000-00000000000000000000000000000000',

      channel: 'C12345678',

      topic: 'This topic was last updated at ' + Date.now()

    });

The response from Slack will be passed straight back through to you. In practice, this means that if `response.ok` is `true`, the actions have successfully completed.

Alternatively, you can instead pass an array of channel IDs as `channels`. If you do this, you'll also receive an array of Slack responses back - one for each channel.

    const response = await slackTopicUpdater.update({

      token: 'xoxp-0000000000-000000000000-000000000000-00000000000000000000000000000000',

      channels: [

        'C12345678',

        'C98765432'

      ],

      topic: 'This topic was last updated at ' + Date.now()

    });

## Authorisation

To get your Slack token, create an app from [api.slack.com/apps](https://api.slack.com/apps). After making it to the app management screen, from _Features: OAuth & Permissions_, and then under _Scopes_, you'll need to select:

* `channels:write` (to set the topic);

* `channels:history` (to search for the topic update message);

* `groups:write` (to set the topic in **private channels**);

* `groups:history` (to search for the topic update message in **private channels**); and

* `chat:write:user` (to delete the topic update message).

NOTE: The private channel scopes are only required if you want to update the topic in private channels. If you'll only be using public channels, you should leave these scopes out. Also note that the app will only be able to access channels that you are in (this applies to *both* public and private channels).

Once you've added the scopes, follow the instructions under _Settings: Install App_. You should be provided with an _OAuth Access Token_, which is what you'll need to send through to this module. Bot user tokens are not supported by the [`channels.setTopic`](https://api.slack.com/methods/channels.setTopic) endpoint, so they can't be used here - you must use a user token instead.

## Running Tests

    npm test

or

    yarn test

## Problems?

Please feel free to [log an issue](https://github.com/tdmalone/slack-topic-updater/issues/new), or - if you can solve a problem yourself - pull requests will be gladly accepted. If you add new functionality, please add tests to cover it.

If you are receiving errors from the Slack API, depending on the error ensure you have set up the correct scopes (documented under *Authorisation* above); provided the correct token; and are in the channel you are trying to update. API errors that indicate something is amiss here can include `missing_scope`, `invalid_auth`, `not_in_channel`, and `channel_not_found`.

## License

[MIT](LICENSE).