Jenkins Integration
Connect Jenkins with OnPage so important events reach the on-call team when they need attention.
Trigger: A configured Jenkins job or Pipeline run reaches a selected build outcome, such as failure or instability.
How It Works
- Create an API integration in OnPage for the team that should receive Jenkins alerts.
- Configure the relevant Jenkins job or Pipeline for the OnPage response team.
- Select the events and conditions that require an on-call response.
- When the configured job or Pipeline matches a selected event or condition, Jenkins sends the event to OnPage.
- OnPage creates an alert for the receiving team with relevant Jenkins context.
- The on-call team reviews and responds to the alert in OnPage.
Requirements
- Access to configure the relevant Jenkins workflows and notifications.
- A configured job or Pipeline with events that warrant an on-call response.
- An OnPage API integration configured for the alert-receiving team.
Setup
1. Create the API Integration in OnPage
Create an API integration for Jenkins in OnPage and associate it with the team that should receive alerts. Contact your OnPage administrator if you need help setting up the integration.
2. Configure Jenkins
In Jenkins, configure the relevant job or Pipeline to use the OnPage integration provided for your environment.
3. Configure Notification Conditions
Choose the events and conditions that require an on-call response. Save the job or Pipeline configuration after confirming that the selected conditions match the events that require a response.
OnPage Status Updates
If you are looking for a bi-directional integration and the documentation does not definitively confirm that it is supported, please reach out to our Support team at [email protected].
Verify the Integration
- Run a safe test that reaches one of the selected notification conditions.
- Confirm that an OnPage alert is created for the receiving team.
- Check that the alert identifies the Jenkins event that triggered it.
