Skip to main content
Version: Next

Webhooks

Visit config-ui: http://{localhost}:4000.

Step 1 - Add a new incoming webhook​

Go to the 'Connections' page. Create a webhook with a unique name.

webhook-add-data-connections

Step 2 - Create webhooks connection​

Click on Generate POST URL, and you will find three webhook URLs.

webhook-connection1

Copy the ones that suit your usage into your CI/CD or issue-tracking systems. You can always come back to the webhook page to copy the URLs later on.

A non-expired API key is auto-generated for the authentication of the webhook. This API key only shows in the payload when you create the webhook. However, you can always revoke and generate a new token when you view the webhook details.

See the full payload schema of webhooks.

Step 3 - Use webhook in a project​

If you want to use webhook data to measure DORA metrics, you have to associate it with a DevLake project.

  • Go to the 'Incoming Webhooks' tab on a project's page.
  • Add webhook by selecting the existing webhook.
  • Go to the project's blueprint page and click 'Collect Data'. This will trigger the DORA plugin to measure DORA metrics with the data collected by the data connections and webhooks associated with this project.

project-webhook-use

Put webhook on the internet​

For the new webhook to work, it needs to be accessible from the DevOps tools from which you would like to push data to DevLake. If DevLake is deployed in your private network and your DevOps tool (e.g. CircleCI) is a cloud service that lives outside of your private network, then you need to make DevLake's webhook accessible to the outside cloud service.

There are many tools for this:

  • For testing and quick setup, ngrok is a useful utility that provides a publicly accessible web URL to any locally hosted application. You can put DevLake's webhook on the internet within 5 mins by following ngrok's Getting Started guide. Note that, when posting to webhook, you may need to replace the localhost part in the webhook URL with the forwarding URL that ngrok provides.
  • If you prefer DIY, please check out open-source reverse proxies like fatedier/frp or go for the classic nginx.

Note: If you post incidents using webhook due to your tool not being supported but your deployments are collected via plugins automatically, you need to re-collect data for deployments for the posted incidents to get mapped to deployments based on timestamps. This is required for Change Failure Rate (DORA) metric to show up correctly for the project.

Troubleshooting​

If you run into any problems, please check the Troubleshooting or create an issue.