Skip to main content
Version: v0.17



Incoming Webhooks are your solution to bring data to Apache DevLake when there isn't a specific plugin ready for your DevOps tool. An Incoming Webhook allows users to actively push data to DevLake.

When you create an Incoming Webhook within DevLake, DevLake generates a unique URL. You can then post JSON payloads to this URL to push data directly to your DevLake instance.

In v0.14+, users can push "incidents" and "deployments" required by DORA metrics to DevLake via Incoming Webhooks.


Check out the Incoming Webhooks entities collected by this plugin.


Metrics that can be calculated based on the data collected from Incoming Webhooks:


API Sample Request


If you want to collect deployment data from your system, you can use the incoming webhooks for deployment.

Payload Schema

You can copy the generated deployment curl commands to your CI/CD script to post deployments to Apache DevLake. Below is the detailed payload schema:

pipeline_id✖️ Norelated Domain Layer
environment✖️ Nothe environment this deployment happens. For example, PRODUCTION STAGING TESTING DEVELOPMENT.
The default value is PRODUCTION
repo_url✔️ Yesthe repo URL of the deployment commit
If there is a row in the domain layer table repos where repos.url equals repo_url, the repoId will be filled with
repo_id✖️ Norelated Domain Layer
No default value.
ref_name✖️ Norelated branch/tag
No default value.
commit_sha✔️ Yesthe sha of the deployment commit
create_time✖️ NoTime. Eg. 2020-01-01T12:00:00+00:00
No default value.
start_time✔️ YesTime. Eg. 2020-01-01T12:00:00+00:00
No default value.
end_time✔️ YesTime. Eg. 2020-01-01T12:00:00+00:00
The default value is the time when DevLake receives the POST request.
result✖️ Nodeployment result, one of the values : SUCCESS, FAILURE, ABORT, MANUAL,
The default value is SUCCESS.

Register a Deployment - Sample API Calls

Sample CURL to post deployments to DevLake. The following command should be replaced with the actual curl command copied from your Config UI:

curl -X 'POST' -d '{
"pipeline_id": "optional-pipeline-id",
"repo_id": "optional-repo-id",
"ref_name": "optional-release-v0.17",
"result": "FAILURE",

If you have set a username/password for Config UI, you'll need to add them to the curl command to register a deployment:

curl -X 'POST' -u 'username:password' -d '{

A real-world example - Push CircleCI deployments to DevLake

The following demo shows how to post "deployments" to DevLake from CircleCI. In this example, the CircleCI job 'deploy' is used to manage deployments.

version: 2.1

- image: cimg/base:stable
- checkout
- run:
name: "build"
command: |
echo Hello, World!

- image: cimg/base:stable
- checkout
- run:
name: "deploy"
command: |
# The time a deploy started
start_time=`date '+%Y-%m-%dT%H:%M:%S%z'`

# Some deployment tasks here ...
echo Hello, World!

# Send the request to DevLake after deploy
# The values start with a '$CIRCLE_' are CircleCI's built-in variables
curl -X 'POST' -d "{

- build
- deploy

Incident / Issue

If you want to collect issue or incident data from your system, you can use the two webhooks for issues.

Register Issues - Update or Create Issues


needs to be called when an issue or incident is created. The body should be a JSON and include columns as follows:

url✖️ Noissue's URL
issue_key✔️ Yesissue's key, needs to be unique in a connection
title✔️ Yes
description✖️ No
epic_key✖️ Noin which epic.
type✖️ Notype, such as bug/incident/epic/...
status✔️ Yesissue's status. Must be one of TODO DONE IN_PROGRESS
original_status✔️ Yesstatus in your system, such as created/open/closed/...
story_point✖️ No
resolution_date✖️ Nodate, Format should be 2020-01-01T12:00:00+00:00
created_date✔️ Yesdate, Format should be 2020-01-01T12:00:00+00:00
updated_date✖️ Nodate, Format should be 2020-01-01T12:00:00+00:00
lead_time_minutes✖️ Nohow long from this issue accepted to develop
parent_issue_key✖️ No
priority✖️ No
original_estimate_minutes✖️ No
time_spent_minutes✖️ No
time_remaining_minutes✖️ No
creator_id✖️ Nothe user id of the creator
creator_name✖️ Nothe user name of the creator, it will just be used to display
assignee_id✖️ No
assignee_name✖️ No
severity✖️ No
component✖️ Nowhich component is this issue in.

More information about these columns at DomainLayerIssueTracking.

Register Issues - Close Issues (Optional)


needs to be called when an issue or incident is closed. Replace :issueId with specific strings and keep the body empty.

Register Issues - Sample API Calls

Sample CURL for Issue Creating :

curl -X 'POST' -d '{"url":"","issue_key":"DLK-1234","title":"a feature from DLK","description":"","epic_key":"","type":"BUG","status":"TODO","original_status":"created","story_point":0,"resolution_date":null,"created_date":"2020-01-01T12:00:00+00:00","updated_date":null,"lead_time_minutes":0,"parent_issue_key":"DLK-1200","priority":"","original_estimate_minutes":0,"time_spent_minutes":0,"time_remaining_minutes":0,"creator_id":"user1131","creator_name":"Nick name 1","assignee_id":"user1132","assignee_name":"Nick name 2","severity":"","component":""}'

Sample CURL for Issue Closing:

curl -X 'POST'