Job webhook events

Events

Event Description
job.scheduled A command step job is in a scheduled state and is waiting to run on an agent
job.started A command step job has started running on an agent
job.finished A job has finished
job.activated A block step job has been unblocked using the web or API

Request body data

Property Type Description
job Job The job this notification relates to
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": "job.started",
  "job": {
    "...": "..."
  },
  "build": {
    "...": "..."
  },
  "pipeline": {
    "...": "..."
  },
  "sender": {
    "id": "8a7693f8-dbae-4783-9137-84090fce9045",
    "name": "Some Person"
  }
}

Trigger job events

When a trigger step in the parent pipeline finishes, the job.finished webhook will include an async field that shows whether the step runs asynchronously.

Example job.finished request body for a trigger job:

{
  "event": "job.finished",
  "job": {
    "id": "...",
    "type": "trigger",
    "name": "...",
    "state": "...",
    "async": true,
    "...": "..."
  },
  "build": {
    "...": "..."
  },
  "pipeline": {
    "...": "..."
  },
  "sender": {
    "id": "8a7693f8-dbae-4783-9137-84090fce9045",
    "name": "Some Person"
  }
}

The async field indicates:

  • true: The trigger step continues immediately, regardless of the triggered build's success.
  • false: The trigger step waits for the triggered build to complete before continuing.