Looking for beta testers - Custom Incoming Webhook and Deployment events/metrics

[#1]

Hey everyone, we're looking for some feedback on a new approach to helping get data into Compass using what we call a custom incoming webhook. Today we've got a few "branded" incoming webhooks to help you get events & metrics into Compass purely through webhooks (no apps, no auth setup needed), but we've long dreamed of giving you a way to do this for any tool/app/system that supports sending a webhook to us. We have a first step nearly ready for testing which can help get Deployment activity (more event types coming) into Compass from anywhere we don't currently have an integration with. Examples: ArgoCD, TeamCity, Jenkins, etc. 

So if you use a tool other than GitHub Actions, Bitbucket Pipelines, GitLab Pipelines, or CircleCI (all of which we have integrations for!) to deploy this may be of interest. Drop me a note at jcampbell2@atlassian.com with your Compass tenant (e.g. foo.atlassian.net) and I'll add you to the test group and provide more instructions.

[Phill Pafford]

@Josh Campbell 

Does this include Bitbucket Data Center and/or Bamboo Data Center?

[Josh Campbell]

Hey @Phill Pafford yes this will work with Bamboo for capturing Deployment events and metrics! 

[Phill Pafford]

@Josh Campbell How does one sign up to be apart of the beta testers?

[Josh Campbell]

Hey Phil drop me an email at jcampbell@atlassian.com with your Compass tenant (e.g. foo.atlassian.net) and I'll add you to the test group and provide more instructions.

[Phill Pafford]

@Josh Campbell hmm, that email bounced back, and I also clicked on your profile and sent an email to that email as well, nothing yet

[Nitin Jain]

Hey @Josh Campbell I've created a incoming webhook for the sonar cloud and added that to sonar cloud webhooks too, but I can't see data/events feed back to the component dashboard, how to debug if I get the data back to compass and also to check how much time it take to update the webhook data?

[Pete Stanley]

Hey @Josh Campbell 

I'm just getting around to properly having a play with custom web hooks coming from Sonarqube but have hit a small snag.

Using SonarQube as my custom tool, I've managed to send webhooks to Compass as deployment events - Great!

The last issue I'm having is providing the Compass Webhook configuration with a componentId from the below JSON payload using JQ style dot notation.

Payload:

{ "properties":{
 "sonar.analysis.detectedscm": "git",
 "sonar.analysis.detectedci": "Github Actions",
 "sonar.analysis.componentId": "ari:cloud:compass:abcd-efghijklmnop:component/abcd-efghijklmnop/abcd-efghijklmnop"
 }
}

The only option I have from SonarQube to add custom properties to it's outbound webhook payload is using keys with the prefix "sonar.analysis.*".

These unfortunately include literal dots in the key names. As such, I need to escape them, or use a jq systle syntax such as '.properties["sonar.analysis.componentId"]'.

Unfortunately all syntax variations I've tried via the Compass custom webhook configuration aren't supported - See screenshot.

Can you advise on a path forward to support JSON keys with dots in them? The feature otherwise works great! Many thanks!

[Pete Stanley]

Hey @Josh Campbell

I've dug into this^  further. Looks like the modal above simply doesn't allow any special characters.

For our use-case with Sonarqube, we have no other option to include a key without dots in the webhook payload. Sure there are other tools that will be similar. Hope this is something that can be addressed soon.

---

Side note:
It would be awesome if we could optionally use slug or repository name to identify the component in the inbound webhook instead of componentId.

In our use case, slugs always match the repo name. Given it's likely our tools are already passing the repo name in their payload, it's a lot easier to map this way rather than first having to get the componentId into the tool where we have limit options to customize the payload.

I imagine the limitation is that Compass `/gateway/api/compass/v1/events` endpoint doesn't support anything other than componentId. Not sure whether the path forward would be to add support to allow slug in the `events` api or to enum componentId from slug within the custom webhooks extension.

...Food for thought anyhow...

[Enrique Serrano Valle]

@Pete Stanley good feedback! Thank you for pointing that out. 

In the meantime, if you're looking for a way to integrate SonarQube with Compass, there are a couple of alternatives that may be easier than custom webhooks - there's a Compass SonarQube App that SonarQube maintains, and there's also a SonarQube branded webhook integration that uses Compass incoming webhooks.