Skip to content

Jenkins Sensor ​

What it ingests ​

CI/CD build results from Jenkins — deploys, failures, and recovery patterns. The source is webhook-driven: Jenkins POSTs build notifications to Corveil, so there's no outbound polling and on-prem Jenkins works through any firewall.

Credential ​

None to create. Unlike the polling sources, the Jenkins webhook token is generated when you create the sensor. The plaintext token is returned once in the create response so the UI can show you the full webhook URL — copy it then; it isn't shown again.

Config fields ​

Both config fields are optional.

KeyNotes
instance_labelHuman-readable name shown in the UI, e.g. acme-prod-jenkins. Display-only; not used for auth.
job_allowlistComma-separated job names to ingest, e.g. deploy-prod, deploy-staging. Applied at ingest time by the webhook handler. Blank accepts all jobs.

Wire-up ​

POST /api/sensors

json
{
  "sensor_type": "jenkins",
  "name": "Acme Jenkins",
  "config": {
    "instance_label": "acme-prod-jenkins",
    "job_allowlist": "deploy-prod, deploy-staging"
  }
}

The response includes the generated webhook URL + token. Save it. If you lose it, Edit sensor → Get webhook URL (or POST /api/sensors/{id}/rotate-webhook) issues a new URL and immediately invalidates the previous one.

Then confirm the bindings. A new sensor stores the build events it receives but does not process them until you do: POST /api/sensors/{id}/confirm-bindings, or corveil control knowledge sensors-confirmBindings {id}, or the control_sensors_confirmBindings MCP tool, or Sensors → Bindings → Confirm bindings & start processing. Events stored before then are processed on the next processing cycle after it. The create response's next_steps names this call with the sensor's id.

To skip that step, add "confirm_bindings": true to the create body: the sensor starts with its seeded build bindings confirmed.

Provider-side setup ​

Point Jenkins at the webhook URL from the create response. Use the Notification plugin (or a curl post-build step) to POST build results to that URL on job completion. Only jobs in job_allowlist are ingested if you set one.

Every POST Corveil accepts answers 200 with a JSON status:

statusMeaning
acceptedStored. It is processed on the next processing cycle.
duplicateThis build phase was already received; nothing new was stored.
heldStored, but not processed until the bindings are confirmed (reason: bindings_not_confirmed).
ignoredNot stored. reason is job_not_allowlisted (the job is not in job_allowlist) or phase_not_recorded (only STARTED and COMPLETED are recorded).

Verify ​

Trigger a build (or run the allowlisted job). The response to Jenkins should say "status": "accepted"; held means the bindings still need confirming. The build result should appear as a CI/CD event shortly after the job finishes. If nothing arrives, re-check the webhook URL/token in Jenkins and that the job name matches the allowlist.