build_events.md

Build webhook events

Events

Event	Description
build.scheduled	A build has been scheduled
build.running	A build has started running
build.finished	A build has finished
build.failing	A build is failing

Request body data

Property	Type	Description
build	Build	The build this notification relates to
pipeline	Pipeline	The pipeline this notification relates to
sender	String	The user who created the webhook

Example request body:

{
  "event": "build.scheduled",
  "build": {
    "...": "..."
  },
  "pipeline": {
    "...": "..."
  },
  "sender": {
    "id": "8a7693f8-dbae-4783-9137-84090fce9045",
    "name": "Some Person"
  }
}

Finding out if a build is blocked

If a build is blocked, look for blocked: true in the build.finished event

Example request body for blocked build:

{
  "event": "build.finished",
  "build": {
    "...": "...",
    "blocked": true,
    "...": "..."
  },
  "pipeline": {
    "...": "..."
  },
  "sender": {
    "id": "0adfbc27-5f72-4a91-bf61-5693da0dd9c5",
    "name": "Some person"
  }
}

📘 To determine if an Eventbridge notification is blocked However, to determine if an Eventbridge notification is blocked, look for "state": "blocked". , like in this sample Eventbridge request.