webhooks
ciBuild.statusChanged
When the status of a CI build changes.
postWebhookciBuild.statusChanged
Payload
Example payload
{
"app": {
"id": "fake-app",
"appName": "Fake app",
"createdAt": "2022-03-02T01:15:00Z"
},
"release": {
"id": "fake-app:1.0.0",
"version": "1.0.0",
"createdAt": "2022-03-02T01:15:00Z",
"releasePilotId": "sully@example.com",
"targetKickoffDate": "2022-03-02T01:15:00Z",
"targetSubmissionDate": "2022-03-02T01:15:00Z",
"targetReleaseDate": "2022-03-02T01:15:00Z",
"releaseBranch": "release-1.0.0",
"updatedAt": "2022-03-02T01:15:00Z",
"kickedOffAt": "2022-03-02T01:15:00Z",
"submittedAt": "2022-03-02T01:15:00Z",
"releasedAt": "2022-03-02T01:15:00Z",
"rolloutCompletedAt": "2022-03-02T01:15:00Z",
"completedAt": "2022-03-02T01:15:00Z",
"regressionTestingStatus": {
"updatedAt": "2022-03-02T01:15:00Z"
},
"workItems": [
{
"id": "acb-1234",
"ticket": {
"createdAt": "2022-03-02T01:15:00Z",
"updatedAt": "2022-03-02T01:15:00Z"
},
"code": {
"committedAt": "2022-03-02T01:15:00Z",
"authoredAt": "2022-03-02T01:15:00Z"
}
}
],
"steps": [
{
"data": {
"approvalItems": [
{
"title": "Gather new release notes",
"description": "Contact sully@demo.com on the copywriting team to get new release notes together.",
"oneOffForVersion": "1.1.0",
"status": {
"createdAt": "2022-03-02T01:15:00Z"
}
}
]
},
"checklistItems": [
{
"title": "Gather new release notes",
"description": "Contact sully@demo.com on the copywriting team to get new release notes together.",
"oneOffForVersion": "1.1.0",
"status": {
"createdAt": "2022-03-02T01:15:00Z"
}
}
]
}
],
"customMetadata": {
"incident-4821": {
"title": "Incident link",
"value": "https://incidents.example.com/4821"
}
}
},
"build": {
"buildHash": "abc123def456",
"buildIdentifier": "123",
"buildUrl": "https://ci.example.com/build/123",
"buildStartedAt": "2022-03-02T01:15:00Z",
"buildFinishedAt": "2022-03-02T01:20:00Z",
"providerBuildStatusString": "In progress",
"commit": "abcdef123456",
"commitMessage": "Fix bug in authentication",
"commitAuthor": "John Doe",
"commitUrl": "https://github.com/org/repo/commit/abcdef123456",
"workflowName": "CI Build",
"branchName": "main",
"workflowRunIdOrCommaDelimitedIds": "workflow-run-123"
}
}Response
Return a 200 status to indicate that the data was received successfully
Changes
Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.