Kore.ai provides integration for a built-in Jenkins Bot that you can use to display message notifications and execute tasks directly from the Kore.ai application. To use the Jenkins Bot, you just need to add the Bot to your Kore.ai account, and then configure the settings for the Bot, such as authentication to access Jenkins, and the notification messages that you want. This topic describes the Jenkins built-in Bot for Kore.ai. For more information about other Kore.ai Bots, see Adding Bots.
About the Kore.ai Bot for Jenkins
Jenkins is an open-source, continuous build management tool that enables teams to focus on their work by automating the build, artifact management, and deployment process.
|Integration Type||Webhook – Connect to this Bot using a webhook integration where the web application pushes message notifications in near real time.|
|Category||Developer Tools – This Bot is available in the Kore.ai application in the Developer Tools category.|
To configure a Jenkins webhook for Kore.ai, you must have a Jenkins account with administrator access as well as API access to configure a webhook. If you don’t, you’ll need to contact theJenkins system administrator for your company. For more information, see the Administering Jenkins in the Jenkins documentation.
To get started configuring the webhook in Jenkins, you’ll need two things:
- The Kore.ai webhook URL provided when you set up an alert in your Kore.ai account for each alert that you want to enable in Jenkins.
- A valid Username and Password for an account with Jenkins API access.
The webhook URL is account-specific and cannot be transferred to any other account. This means that if you configure a Jenkins webhook using a test account, you will have to recreate the alert and get a new webhook URL to configure in Jenkins. The following URL is an example webhook URL.
This procedure describes the steps in Jenkins to upload the the kore.hpi file, and then configure the events that trigger alerts to Kore.ai, and finally, adding the Kore.ai webhook URL.
- Download the kore.hpi file using the link at the bottom of this page in the Article Attachments section, and save to a local directory on your computer.
- Log on to Jenkins and on the Dashboard page, on the left navigation menu, click Manage Jenkins. The Manage Jenkins page is displayed.
- Click Manage Plugins to display a list of plugins.
- On the Advanced tab, in the Upload Plugin section, click Choose File, navigate to, and then select the kore.hpi file that you downloaded previously, and then click Upload.
- On the left navigation menu, click Back to Dashboard.
- On the All tab, select the job that you want to add a webhook to. The Project <My Job Name> page is displayed.
- On the left navigation menu, click Configure. The Configuration page for the job is displayed.
- Click the Advanced button located on the lower right of the page. Additional options for the job are displayed.
- In the Kore.ai Notifications section, select one or more events that you want to get Kore.ai alert messages for.
- In the Kore.ai Notifications section, in the Team Domain field, enter the Kore.ai webhook URL for the alert.
- In the Post-build Actions section, select Kore.ai Notifications, and then click Save.
For more information, see Meet Jenkins in the Jenkins documentation.
After you are connected, you can perform tasks for Jenkins directly from the Kore.ai application and setup message notifications to get notified in the Kore.ai application when an event occurs in Jenkins.
You can integrate a Jenkins task with Kore.ai. To configure the Trigger a Build task, click , click Trigger a Build, and then in the Perform Task dialog, select a Job.
In a space room, you can enter the @jenkins triggerbuild Bot command to invoke and configure this task.
You can setup message notifications to your Kore.ai account using a Jenkins webhook. Click , click Get notified when…, click Build Notifications, and then in the Setup Task dialog:
- select a Project/Job
- optionally, click the gray box in Filters to setup one or more filters to prevent message notifications for specified criteria. You can filter on the following:
- Build Status
- Click Done to save the filter. For more information, see Setting up Filters.
- optionally customize the Task Name
- optionally customize the Short Description
- enable or disable Mute task notifications.
After the webhook is configured in Jenkins, when any of the events occur in Jenkins,a message is displayed on the Bots tab in the Messages section for the Kore.ai account.