Slack

Get updates on your docs directly within Slack!

The ReadMe Slack App allows you to receive project notifications in your Slack workspace. This integration currently supports notifications for:

If your project has API Metrics enabled, you will also be able to access powerful insights about your API usage (top users, recent logs, etc.) via a weekly summary message and slash commands. You will be able to choose which channel the project notifications get sent to. Slash commands will be available for use in any channel or DM.

Setup and Configuration

To connect your ReadMe project to your Slack workspace, go to the Integrations section in the ReadMe dashboarddashboard - The administration dashboard for your documentation project is at dash.readme.com/project/<yourProject>/. The dashboard contains all of your projects and settings. (Configuration > Integrations), and click the Add to Slack button:

You'll be redirected to a Slack authorization page where you can select which channel/DM in your workspace that you'd like to send notifications and the weekly API Metrics summary to. Once you've authorized Slack, you will be redirected back to the ReadMe Integrations page, where you can configure your notifications by clicking Manage Slack Integrations.

A modal will pop up where you can configure which notifications you would like to receive. By default, all notifications and the API Metrics weekly summary are enabled.

πŸ“˜

Tip: Send different notifications to different channels

You can add as many Slack integrations to your workspace as you think makes sense for your workflow, making it easy to send notifications to #channel-1 for Suggested Edits, #channel-2 for Discussion posts, @owlbert for everything, and so on. Just click the Add to Slack button for every new integration you wish to set up!

Pausing/Disabling The Slack Integration

If you no longer wish to receive ReadMe notifications in your Slack workspace (or if you just need a break), you can do one of the following:

  1. If you'd like to temporarily pause incoming messages, navigate to the Integrations section of your project dashboard, click the Manage Slack Integrations link, which will open a modal where you can select/unselect the notifications you wish to receive.
  2. To disable incoming messages for a given channel, open the aforementioned Manage Slack Integrations modal and click the Manage Configuration in Slack link for the channel/DM you wish to disable. You'll be taken to the Slack App configuration page. Select the Configuration tabβ€”from here, you'll see a list of all the "incoming webhooks" (which is another term for the Slack integrations that allows us to send messages to your channel/DM you've configured. Click the "Revoke" button next to the webhook(s) you'd like to disable, which will deactivate the corresponding Slack integration in our system.
  3. To disable all incoming messages AND slash commands for your entire workspace, navigate to the aforementioned Slack App configuration page. Within the Configuration tab, you can remove the entire ReadMe Slack App by clicking the "Remove App" button at the bottom of the page. But be warnedβ€”revoking access for the entire app also revokes it for all members of your Slack workspace, so make sure everyone else is cool with it!

And of courseβ€”if you change your mind and want to set up the Slack App again, just follow the steps above on setting up a new integration!

πŸ“˜

Why am I still seeing the settings for a Slack integration even though I've revoked it in Slack?

Immediately upon revoking an incoming webhook on the Slack Authorizations page (if you followed option two above), you may still see it listed and active in the Manage Slack Integrations modal. Don't worry! We will no longer send you notifications to that channel/DM (seriously β€” we literally couldn't if we tried!). The next time we attempt to use the integration, Slack will inform us that access to the webhook has been revoked and we'll mark it as deactivated within our system.

Deactivated Slack Integrations

We may run into an error when attempting to send notifications to your Slack channel. This may happen for a variety of reasons, including (but not limited to):

  • The permissions on the channel have since changed
  • The channel has been archived or deleted
  • You've disabled the Slack integration, either just for a channel or for the entire workspace
  • Your organization has switched to carrier pigeons for internal communications and you've deleted your entire Slack workspace πŸ•ŠοΈ

If we receive an error along these lines, we flag the integration as deactivated and stop sending messages to it. The next time you open up the Manage Slack Integrations modal in the dashboard, you'll see something like this:

If the deactivation appears to be expected, feel free to click "Remove Slack Integration" to remove it for good! We only keep in our system for your records. If you wish to reactivate the Slack integration again, we recommend that you clear out any deactivated integrations and click the "Add to Slack" button to set one up againβ€”it only takes a few clicks!

If you need more information on the deactivation or believe this was in error, feel free to contact us!


Did this page help you?