Skip to main content

How do I add Gearset notifications to a Slack channel?

Slack configuration and setup instructions to enable Gearset to send notifications, alerts and job status updates to your Slack channels.

Samuel Crossland avatar
Written by Samuel Crossland
Updated over a week ago

Note: There is a chance this process may change as Slack continues to evolve. You can find the latest Slack documentation here.

Creating a Slack ‘app’ for inbound messaging

In order to specify a Slack channel for Gearset notifications, an ‘app’ must first be configured in Slack. After the 'app' is created, you'll need to enable the webhooks (if not already enabled), create a new incoming hook, and then use that hook to receive and post a message.

  1. Click ‘Create a Slack app’. (You may want to create a new one so you can control each app’s purpose and keep this one for messaging).

  2. Select ‘From scratch’ to set up a new app.

  3. Name your app (e.g. ‘Gearset Integration), select the workspace to link it to and click 'Create App'.

  4. Choose 'Incoming Webhooks' from the ‘Add features and functionality’ accordion.

  5. Enable ‘Activate Incoming Webhooks’ using the toggle in the top right.

  6. Click ‘Add New Webhook To Workspace’.

  7. Select the specific channel from the drop-down your webhook will post into and allow. If you need to make a new channel for this, please see this Slack article for instructions on how to create one.

  8. The generated webhook is displayed inside the ‘Webhook URLs for Your Workspace’ section. Slack is now configured to receive data from this app and post it into the relevant channel. Note: When copying the URL, ensure it reads ‘/services’ and not ‘/workflows’.

Sending updates to the Slack channel from Gearset

When configuring Slack notifications in Gearset for automated jobs, simply use the generated Slack webhook URL. See our documentation for unit testing, change monitoring, or continuous integration for further instructions.

It's important not to share your Slack webhook URL with anyone who shouldn't have access as it allows direct posting to your Slack channels.

Troubleshooting: what if I don’t get a notification after configuring it?

There are multiple reasons why a webhook may not be working properly, but the first thing to check is that the Webhook URL from slack looks like this:

https://hooks.slack.com/services/xxxxxx/xxxxxxxx/xxxxxxxxxxxxx

and not like this:

https://hooks.slack.com/workflows/xxxxxx/xxxxxxxx/xxxxxxxxxxxx

The above URL containing 'services' ensures the data is flowing into a Slack service hook, rather than a more complex workflow which usually contains multiple steps and Gearset isn’t compatible with.

If you have any problems getting these Slack notifications set up get in touch via the in-app chat or by emailing support@gearset.com.

Did this answer your question?