Last updated Feb 24, 2024

Create incoming webhooks

Get data quickly and easily from across your toolchain into Compass with incoming webhooks. Visualize component events from all your tools in a unified place in real time. Use those events to power metrics and scorecard calculations to get strong guidance toward cultivating and maintaining healthy DevOps practices.

Creating an incoming webhook gives you a unique URL, which you can use to send events from your tools to one or more Compass components. With minor configurations in your tools and linking your Compass components to those tools, you can get the data flowing into Compass.

Learn more about incoming webhooks

Before you begin

Ensure you have a full user role in Compass.

Create an incoming webhook

  1. In the main navigation, select Settings (Settings icon).

  2. In the left sidebar, select Incoming webhooks.

  3. Fill out the webhook details:

    • Select the source where your events are generated—for example, GitHub.
    • Name and describe the incoming webhook to help people understand how to use it.
  4. Select Create.

On the next screen, you’ll get a unique webhook URL that you can use to add a webhook in your source tool. Follow the instructions for your specific tool to configure the webhook.

Treat the unique webhook URL like a secret. Be careful who you share it with, and store it like a password.

Next step

Configure the incoming webhook in your source tool. The configuration steps may vary for different tools. Follow the configuration steps for your specific tool.

Supported versions

Compass supports specific versions of self-hosted tools for use with incoming webhooks:

  • GitHub Enterpriser Server: version 3.11 or higher
  • GitLab self-managed: version 16.8 or higher

Troubleshooting

I can’t see the incoming webhooks page

Check that you have a full user role in Compass to create and use incoming webhooks.

I’m getting an error when creating an incoming webhook

Sometimes, this could happen due to a temporary network issue. Try creating the webhook again.

Rate this page: