Commit 0795a27f authored by Evan Read's avatar Evan Read

Merge branch 'docs/build-to-job-webhooks' into 'master'

Rename build to job in webhooks docs

Closes #42254 and #28226

See merge request gitlab-org/gitlab-ce!26676
parents a5d1b8a2 a57f46b4
...@@ -48,7 +48,7 @@ Navigate to the webhooks page by going to your project's ...@@ -48,7 +48,7 @@ Navigate to the webhooks page by going to your project's
## Use-cases ## Use-cases
- You can set up a webhook in GitLab to send a notification to - You can set up a webhook in GitLab to send a notification to
[Slack](https://api.slack.com/incoming-webhooks) every time a build fails, for example [Slack](https://api.slack.com/incoming-webhooks) every time a job fails.
- You can [integrate with Twilio to be notified via SMS](https://www.datadoghq.com/blog/send-alerts-sms-customizable-webhooks-twilio/) - You can [integrate with Twilio to be notified via SMS](https://www.datadoghq.com/blog/send-alerts-sms-customizable-webhooks-twilio/)
every time an issue is created for a specific project or group within GitLab every time an issue is created for a specific project or group within GitLab
- You can use them to [automatically assign labels to merge requests](https://about.gitlab.com/2016/08/19/applying-gitlab-labels-automatically/). - You can use them to [automatically assign labels to merge requests](https://about.gitlab.com/2016/08/19/applying-gitlab-labels-automatically/).
...@@ -1004,7 +1004,7 @@ X-Gitlab-Event: Pipeline Hook ...@@ -1004,7 +1004,7 @@ X-Gitlab-Event: Pipeline Hook
"email": "user@gitlab.com" "email": "user@gitlab.com"
} }
}, },
"builds":[ "jobs":[
{ {
"id": 380, "id": 380,
"stage": "deploy", "stage": "deploy",
...@@ -1129,34 +1129,34 @@ X-Gitlab-Event: Pipeline Hook ...@@ -1129,34 +1129,34 @@ X-Gitlab-Event: Pipeline Hook
} }
``` ```
### Build events ### Job events
Triggered on status change of a Build. Triggered on status change of a job.
**Request Header**: **Request Header**:
``` ```
X-Gitlab-Event: Build Hook X-Gitlab-Event: Job Hook
``` ```
**Request Body**: **Request Body**:
```json ```json
{ {
"object_kind": "build", "object_kind": "job",
"ref": "gitlab-script-trigger", "ref": "gitlab-script-trigger",
"tag": false, "tag": false,
"before_sha": "2293ada6b400935a1378653304eaf6221e0fdb8f", "before_sha": "2293ada6b400935a1378653304eaf6221e0fdb8f",
"sha": "2293ada6b400935a1378653304eaf6221e0fdb8f", "sha": "2293ada6b400935a1378653304eaf6221e0fdb8f",
"build_id": 1977, "job_id": 1977,
"build_name": "test", "job_name": "test",
"build_stage": "test", "job_stage": "test",
"build_status": "created", "job_status": "created",
"build_started_at": null, "job_started_at": null,
"build_finished_at": null, "job_finished_at": null,
"build_duration": null, "job_duration": null,
"build_allow_failure": false, "job_allow_failure": false,
"build_failure_reason": "script_failure", "job_failure_reason": "script_failure",
"project_id": 380, "project_id": 380,
"project_name": "gitlab-org/gitlab-test", "project_name": "gitlab-org/gitlab-test",
"user": { "user": {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment