Last updated Jul 17, 2024

Get data from your toolchain using 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.

Webhooks are a programming-language agnostic way of sending messages between systems when something interesting happens in a tool. Incoming webhooks can get data from external tools in your toolchain into Compass.

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.

Benefits

Get data into Compass quickly and easily

You can get data into Compass without relying on a Compass admin to install an app. Anyone with a full user role in Compass can create and use incoming webhooks.

Most third-party tools also let you create and use webhooks without requiring you to have any elevated or admin permissions.

Visualize events in a unified place

Events impacting your components, like deployments, builds, commits, pull requests, incidents, feature flag changes, alerts, and so on, all occur in different tools across your toolchain. Incoming webhooks enable you to bring such events into Compass in real time and visualize them on a component’s activity feed in the context of other events and dependency components. You can get meaningful insights into the component’s activity all from one place without having to navigate across several tools.

For example, an incoming GitHub webhook will get deployment, build, and push events from a GitHub repository to a corresponding Compass component.

Learn more about the activity feed

Automate derived metrics calculations

Compass automatically generates applicable derived metrics for supported event types when an event comes in. For example, when you set up incoming GitHub webhooks, you’ll not only get deployment events in Compass, but metrics such as Deployment frequency will be automatically derived and shown on the component.

Learn more about derived metrics

Automate scorecard calculations

Derived metrics calculations automatically update scorecard values when those metrics are added as scorecard criteria. Each time you receive events, the metrics values are recalculated. The metric values automatically influence the components' scores, which are automatically updated, helping you monitor and track the health of your components and teams over time.

Learn more about how scorecards use metrics

Reuse incoming webhooks with many components

You can create multiple incoming webhooks for a tool or you can reuse one incoming webhook to send events to one or more Compass components. For example, you can have multiple incoming GitHub webhooks and connect each webhook to a different GitHub repository. Or, you can can have one incoming GitHub webhook and connect it to multiple repositories to send events to corresponding components.

Learn how to use existing incoming webhooks

Get started

Learn how to create incoming webhooks

Learn how to use existing incoming webhooks

Learn how to configure incoming webhooks

Rate this page: