Webhooks

Through the repository's Webhook, the server is allowed to call the specified URL when receiving special events.

These special events that can be configured with Webhooks include: code push and code review. The platform will send a Post request with data to the defined URL of the Webhook.

Webhooks can be used to trigger CI builds, perform image backups, and even trigger deployment to production environments.

Event description

Push event

Push events refer to the client pushing code to the server. One exception: the Push tag does not form a push event.

Request header

X-AtomGit-Event: Push Hook

Request body

{
  "object_kind": "push",
  "before": "f2e2d577fab1562a6239b82721fd9827e05fdce6",
  "after": "eb63d0277e64684236ebf8394b919230c4b8a286",
  "ref": "refs/heads/master",
  "user_id": 4,
  "user_name": "atomgit",
  "user_email": "email@atomgit.com",
  "project_id": 15,
  "repository": {
    "name": "Diaspora",
    "url": "git@atomgit.codechina.net:demo/demo.git",
    "description": "",
    "homepage": "https://atomgit.codechina.net/demo/demo",
    "git_http_url":"https://atomgit.codechina.net/demo/demo.git",
    "git_ssh_url":"git@atomgit.codechina.net:demo/demo.git",
    "visibility_level":0
  },
  "commits": [
    {
      "id": "f2e2d577fab1562a6239b82721fd9827e05fdce6",
      "message": "Update readme.",
      "timestamp": "2019-01-01T00:08:00+08:00",
      "url": "https://atomgit.codechina.net/demo/demo/commits/f2e2d577fab1562a6239b82721fd9827e05fdce6",
      "author": {
        "name": "atomgit",
        "email": "email@atomgit.com"
      }
    },
    {
      "id": "eb63d0277e64684236ebf8394b919230c4b8a286",
      "message": "fixed readme",
      "timestamp": "2019-01-03T23:36:29+08:00",
      "url": "https://atomgit.codechina.net/demo/demo/commits/eb63d0277e64684236ebf8394b919230c4b8a286",
      "author": {
        "name": "atomgit",
        "email": "email@atomgit.com"
      },
    }
  ],
  "total_commits_count": 2

}

Tag push event

Fired when a tag is created or deleted.

Request header

X-AtomGit-Event: Tag Push Hook

Request body

{
  "object_kind": "tag_push",
  "ref": "refs/tags/v1.0.0",
  "before": "0000000000000000000000000000000000000000",
  "after": "eb63d0277e64684236ebf8394b919230c4b8a286",
  "user_id": 1,
  "user_name": "atomgit",
  "project_id": 1,
  "repository": {
    "name": "demo",
    "url": "ssh://git@atomgit.codechina.net/demo/demo.git",
    "description": "",
    "homepage": "https://atomgit.codechina.net/demo/demo",
    "git_http_url":"https://atomgit.codechina.net/demo/demo.git",
    "git_ssh_url":"git@atomgit.codechina.net:demo/demo.git",
    "visibility_level":0
  },
  "commits": [],
  "total_commits_count": 0
}

Comment Event

Triggered when any comment is generated, whether it is a comment in a code commit or a code review. Comment data will be stored in the object_attributes field.

Request header

X-AtomGit-Event: Note Hook

Request body

{
  "object_kind": "note",
  "user": {
    "name": "atomgit",
    "username": "atomgit",
    "avatar_url": ""
  },
  "project_id": 5,
  "repository": {
    "name": "demo",
    "url": "https://atomgit.codechina.net/demo/demo.git",
    "description": "demo.",
    "homepage": "https://atomgit.codechina.net/demo/demo"
  },
  "object_attributes": {
    "id": 1243,
    "note": "This is a commit comment. How does this work?",
    "noteable_type": "Commit",
    "author_id": 1,
    "created_at": "2019-05-17 18:08:09 UTC",
    "updated_at": "2019-05-17 18:08:09 UTC",
    "project_id": 5,
    "attachment":null,
    "line_code": "bec9703f7a456cd2b4ab5fb3220ae016e3e394e3_0_1",
    "commit_id": "cfe32cf61b73a0d5e9f13e774abde7ff789b1660",
    "noteable_id": null,
    "system": false,
    "st_diff": {
      "diff": "--- /dev/null\n+++ b/six\n@@ -0,0 +1 @@\n+Subproject commit 409f37c4f05865e4fb208c771485f211a22c4c2d\n",
      "new_path": "six",
      "old_path": "six",
      "a_mode": "0",
      "b_mode": "160000",
      "new_file": true,
      "renamed_file": false,
      "deleted_file": false
    },
    "url": "https://atomgit.codechina.net/demo/demo/commits/cfe32cf61b73a0d5e9f13e774abde7ff789b1660#note_1243"
  },
  "commit": {
    "id": "cfe32cf61b73a0d5e9f13e774abde7ff789b1660",
    "message": "Add submodule",
    "timestamp": "2019-02-27T10:06:20+02:00",
    "url": "https://atomgit.codechina.net/demo/demo/commits/cfe32cf61b73a0d5e9f13e774abde7ff789b1660",
    "author": {
      "name": "Demo",
      "email": "demo@gmail.com"
    }
  }
}

Code review comments

Triggered when any comment is generated, whether it is a comment in a code commit or a code review. Comment data will be stored in the object_attributes field.

Request header

X-AtomGit-Event: Note Hook

Request content

{
  "object_kind": "note",
  "user": {
    "name": "atomgit",
    "username": "atomgit",
    "avatar_url": ""
  },
  "project_id": 5,
  "repository": {
    "name": "demo",
    "url": "https://atomgit.codechina.net/demo/demo/.git",
    "description": "Aut reprehenderit ut est.",
    "homepage": "https://atomgit.codechina.net/demo/demo"
  },
  "object_attributes": {
    "id": 1244,
    "note": "This MR needs work.",
    "noteable_type": "MergeRequest",
    "author_id": 1,
    "created_at": "2019-05-17 18:21:36 UTC",
    "updated_at": "2019-05-17 18:21:36 UTC",
    "project_id": 5,
    "attachment": null,
    "line_code": null,
    "commit_id": "",
    "noteable_id": 7,
    "system": false,
    "st_diff": null,
    "url": "https://atomgit.codechina.net/demo/demo/merge_requests/1#note_1244"
  },
  "merge_request": {
    "id": 7,
    "target_branch": "markdown",
    "source_branch": "master",
    "source_project_id": 5,
    "author_id": 8,
    "assignee_id": 28,
    "title": "Tempora et eos debitis quae laborum et.",
    "created_at": "2019-03-01 20:12:53 UTC",
    "updated_at": "2019-03-21 18:27:27 UTC",
    "milestone_id": 11,
    "state": "opened",
    "merge_status": "cannot_be_merged",
    "target_project_id": 5,
    "iid": 1,
    "description": "Et voluptas corrupti assumenda temporibus. Architecto cum animi eveniet amet asperiores. Vitae numquam voluptate est natus sit et ad id.",
    "position": 0,
    "locked_at": null,
    "source": {
      "name": "demo",
      "ssh_url": "git@atomgit.codechina.net:demo/demo.git",
      "http_url": "https://atomgit.codechina.net/demo/demo.git",
      "web_url": "https://atomgit.codechina.net/demo/demo",
      "namespace": "demo",
      "visibility_level": 10
    },
    "target": {
      "name": "demo",
      "ssh_url": "git@atomgit.codechina.net:demo/demo.git",
      "http_url": "https://atomgit.codechina.net/demo/demo.git",
      "web_url": "https://atomgit.codechina.net/demo/demo",
      "namespace": "demo",
      "visibility_level": 10
    },
    "last_commit": {
      "id": "562e173be03b8ff2efb05345d12df18815438a4b",
      "message": "Merge branch 'another-branch' into 'master'\n\nCheck in this test\n",
      "timestamp": "2019-04-08T21: 00:25-07:00",
      "url": "https://atomgit.codechina.net/demo/demo/commits/562e173be03b8ff2efb05345d12df18815438a4b",
      "url": "https://atomgit.codechina.net/demo/demo/commits/562e173be03b8ff2efb05345d12df18815438a4b",
      "author": {
        "name": "atomgit",
        "email": "atomgit@codechina.com"
      }
    },
    "work_in_progress": false
  }
}

Code review event

Triggered when any comment is generated, whether it is a comment in a code commit or a code review. Comment data will be stored in the object_attributes field.

Request header

X-AtomGit-Event: Merge Request Hook

Request content

{
  "object_kind": "merge_request",
  "user": {
    "name": "atomgit",
    "username": "atomgit",
    "avatar_url": ""
  },
  "object_attributes": {
    "id": 99,
    "target_branch": "master",
    "source_branch": "ms-viewport",
    "source_project_id": 14,
    "author_id": 51,
    "assignee_id": 6,
    "title": "MS-Viewport",
    "created_at": "2019-09-03T17:23:00Z",
    "updated_at": "2019-09-03T17:23:00Z",
    "st_commits": null,
    "st_diffs": null,
    "milestone_id": null,
    "state": "opened",
    "merge_status": "unchecked",
    "target_project_id": 14,
    "iid": 1,
    "description": "",
    "source": {
      "name": "demo",
      "ssh_url": "git@atomgit.codechina.net:demo/demo.git",
      "http_url": "https://atomgit.codechina.net/demo/demo.git",
      "web_url": "https://atomgit.codechina.net/demo/demo",
      "namespace": "demo",
      "visibility_level": 10
    },
    "target": {
      "name": "demo",
      "ssh_url": "git@atomgit.codechina.net:demo/demo.git",
      "http_url": "https://atomgit.codechina.net/demo/demo.git",
      "web_url": "https://atomgit.codechina.net/demo/demo",
      "namespace": "demo",
      "visibility_level": 10
    },
    "last_commit": {
      "id": "da1560886d4f094c3e6c9ef40349f7d38b5d27d7",
      "message": "fixed readme",
      "timestamp": "2019-02-03T23:36:29+02:00",
      "url": "https://atomgit.codechina.net/demo/demo/commits/da1560886d4f094c3e6c9ef40349f7d38b5d27d7",
      "author": {
        "name": "atomgit",
        "email": "atomgit@codechina.com"
      }
    },
    "work_in_progress": false,
    "url": "https://atomgit.codechina.net/demo/demo/merge_requests/1",
    "action": "open"
  }
}

Webhook receiver example

If you want to see the execution effect of Webhook for testing purposes, you can use a simple Echo script

Save the following script as print_http_body.rb.

server = WEBrick::HTTPServer.new(:Port => ARGV.first)
server.mount_proc '/' do |req, res|
  puts req.body
end

trap 'INT' do
  server.shutdown
end
server.start

Select an unused port (such as 8000) and start the script: ruby print_http_body.rb 8000 Then configure the Webhook URL http://my.host:8000/ on AtomGit

Click "Test Hook" on AtomGit and you can see the following content in the command line:

{"before":"f2e2d577fab1562a6239b82721fd9827e05fdce6","after":"eb63d0277e64684236ebf8394b919230c4b8a286"}
aliyun.com - - [14/May/2019:11:11:11 EDT] "POST / HTTP/1.1" 200 0
- -> /

Use HTTP Basic Authentication

When a server that supports HTTP Basic Authentication is triggered, the user name and password are allowed to be added to the URL for access. The Webhook is in the form:

http://userName:password@my.host:8080/project/test-job

Event description​

Push event​

Request header​

Request body​

Tag push event​

Request header​

Request body​

Comment Event​

Request header​

Request body​

Code review comments​

Request header​

Request content​

Code review event​

Request header​

Request content​

Webhook receiver example​

Use HTTP Basic Authentication​

Event description

Push event

Request header

Request body

Tag push event

Request header

Request body

Comment Event

Request header

Request body

Code review comments

Request header

Request content

Code review event

Request header

Request content

Webhook receiver example

Use HTTP Basic Authentication