ServiceNow Jenkins Integration Guide

Architecture Overview

Implementation Steps

var rm = new RESTMessage('Jenkins Build Integration', 'Trigger Build');
rm.setStringParameterNoEscape('job_name', 'my-deployment-job');
rm.setRequestHeader('Authorization', 'Basic ' + gs.base64Encode(username + ':' + api_token));
rm.setRequestBody(JSON.stringify({parameter: [{name: 'CHANGE_NUMBER', value: current.number}]}));
var response = rm.execute();
gs.info('Build triggered with status: ' + response.getStatusCode());

(function process(request, response) {
    var payload = JSON.parse(request.body.data);
    var changeGR = new GlideRecord('change_request');
    if (changeGR.get('number', payload.CHANGE_NUMBER)) {
        changeGR.u_build_status = payload.build_result;
        changeGR.u_build_url = payload.build_url;
        changeGR.u_build_number = payload.build_number;
        if (payload.build_result === 'SUCCESS') {
            changeGR.state = '3'; // Authorize
        } else {
            changeGR.state = '-4'; // Failed
        }
        changeGR.update();
        response.setStatus(200);
    }
})(request, response);

(function executeRule(current, previous) {
    if (current.state == '2' && current.category == 'software') {
        try {
            var rm = new RESTMessage('Jenkins Build Integration', 'Trigger Build');
            rm.setStringParameterNoEscape('job_name', current.u_deployment_job.toString());
            rm.setRequestBody(JSON.stringify({
                CHANGE_NUMBER: current.number.toString(),
                ENVIRONMENT: current.u_target_environment.toString(),
                DEPLOYMENT_WINDOW: current.start_date.toString()
            }));
            var response = rm.execute();
            if (response.getStatusCode() == 201) {
                current.work_notes = 'Jenkins build triggered successfully';
                current.u_build_status = 'TRIGGERED';
            }
        } catch (ex) {
            gs.error('Failed to trigger Jenkins build: ' + ex.getMessage());
            current.work_notes = 'Failed to trigger deployment build: ' + ex.getMessage();
        }
    }
})(current, previous);

var rm = new RESTMessage('Jenkins Build Integration', 'Get Build Artifacts');
rm.setStringParameterNoEscape('job_name', job_name);
rm.setStringParameterNoEscape('build_number', build_number);
var response = rm.execute();
var artifacts = JSON.parse(response.getBody()).artifacts;
for (var i = 0; i < artifacts.length; i++) {
    var artifactGR = new GlideRecord('u_deployment_artifacts');
    artifactGR.initialize();
    artifactGR.u_artifact_name = artifacts[i].fileName;
    artifactGR.u_build_number = build_number;
    artifactGR.u_deployment_date = new GlideDateTime();
    artifactGR.u_related_ci = target_ci_sys_id;
    artifactGR.insert();
}

var failedBuilds = new GlideRecord('change_request');
failedBuilds.addQuery('u_build_status', 'TRIGGERED');
failedBuilds.addQuery('sys_updated_on', '<', gs.minutesAgoStart(30));
failedBuilds.query();
while (failedBuilds.next()) {
    var event = new GlideEvent();
    event.setEventName('jenkins.build.timeout');
    event.setParameter('change_number', failedBuilds.number.toString());
    event.setParameter('build_job', failedBuilds.u_deployment_job.toString());
    event.fire();
    gs.warn('Build timeout detected for change: ' + failedBuilds.number);
}

Common Use Cases

Troubleshooting

Pro Tips

• →Implement retry logic with exponential backoff in your ServiceNow business rules to handle temporary Jenkins server unavailability, storing failed requests in a custom queue table for later processing. This prevents lost build triggers during maintenance windows or network issues while avoiding overwhelming Jenkins with repeated immediate retry attempts.
• →Use ServiceNow's Flow Designer instead of business rules for complex Jenkins integration workflows, as flows provide better error handling, visual debugging, and can leverage the pre-built DevOps spoke actions. Flows also support parallel processing for multi-environment deployments and conditional logic for different deployment types without complex scripting.
• →Configure Jenkins build parameters to include ServiceNow change request URLs and context information, enabling Jenkins build logs to link back to their originating change records for improved traceability. This creates bidirectional navigation between systems and helps developers understand the business context behind their deployments.
• →Implement circuit breaker patterns in your integration scripts to automatically disable Jenkins build triggering when error rates exceed thresholds, preventing cascading failures during Jenkins outages. Use ServiceNow's sys_properties table to store circuit breaker state and automatically re-enable integration once Jenkins health checks pass.
• →Leverage ServiceNow's Transform Maps feature to standardize Jenkins webhook payloads into consistent ServiceNow record formats, making your integration more resilient to Jenkins plugin updates or different job types. This abstraction layer simplifies maintenance and allows for easier integration testing with mock data.
• →Set up ServiceNow Performance Analytics dashboards to track integration metrics like build trigger success rates, average deployment times, and change-to-deployment lead times. These metrics provide valuable insights for DevOps process improvements and help identify bottlenecks in your CI/CD pipeline.

Known Limitations

• —Jenkins REST API has a default rate limit of 100 requests per minute per user, which can be exceeded during bulk change processing or concurrent deployments, requiring queue-based processing for high-volume scenarios. Large ServiceNow instances may need to implement token rotation across multiple Jenkins users or coordinate request timing to stay within limits.
• —The DevOps Integration Hub spoke requires Professional licensing and may not support all Jenkins plugin-specific features or custom build parameter types, necessitating fallback to custom REST Message implementations for advanced use cases. Integration Hub actions also run on ServiceNow infrastructure rather than MID Servers, which may impact connectivity to on-premises Jenkins instances.
• —CMDB artifact synchronization can create significant data volumes over time, as Jenkins builds generate multiple artifacts per deployment, potentially impacting ServiceNow database performance without proper archival strategies. Historical artifact data retention policies must be balanced against compliance requirements and storage costs.
• —Jenkins webhook callbacks can fail silently if ServiceNow instances are temporarily unavailable during deployments, creating gaps in change record status updates that require manual reconciliation. Network latency and timeout configurations between Jenkins and ServiceNow can also cause inconsistent callback delivery during peak usage periods.
• —Complex Jenkins pipeline jobs with dynamic stage generation or conditional deployment paths may not map cleanly to ServiceNow's linear change management workflow, requiring custom logic to handle pipeline branches and stage-specific status updates. Multi-branch pipeline builds particularly challenge traditional change record associations when feature branches deploy to development environments.

Frequently Asked Questions