Kore.ai provides integration for a built-in Buildkite Bot that you can use to display message notifications and execute tasks directly from the Kore.ai application. To use the Buildkite 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 Buildkite, and the notification messages that you want. This topic describes the Buildkite built-in Bot for Kore.ai. For more information about other Kore.ai Bots, see Adding Bots.
About the Kore.ai Bot for Buildkite
Buildkite automates your team’s software development processes, from testing through to delivery, no matter the language, environment, or toolchain.
|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 Buildkite webhook for Kore.ai, you must have a Buildkite account with administrator access as well as API access to configure a webhook. If you don’t, you’ll need to contact theBuildkite system administrator for your company. For more information, see the Getting Started in the Buildkite documentation.
To get started configuring the webhook in Buildkite, 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 Buildkite.
- A valid Username and Password for an account with Buildkite API access.
The webhook URL is account-specific and cannot be transferred to any other account. This means that if you configure a Buildkite webhook using a test account, you will have to recreate the alert and get a new webhook URL to configure in Buildkite. The following URL is an example webhook URL.
This procedure describes the steps in Buildkite to configure a webhook using a Kore.ai webhook URL endpoint.
- Log on to Buildkite, and then on the top menu bar, point to the New Organization menu, and then click the organization that you want to add a webhook to. The Projects page for the selected organization is displayed.
- On the top menu bar, click Settings. The Organization Settings page is displayed.
- On the left navigation menu, click Notifications, and then click the Add button for the Webhook notification. The Add Webhook Notification page is displayed.
- In the Webhook URL field, enter the Kore.ai webhook URL for the alert.
- In the Events section, select one or more events that you want to get Kore.ai alert messages for.
- Optionally, in the Projects section, specify specific projects in the organization to monitorBuildkite events for.
- Click Add Webhook Notification to save the webhook configuration and close the dialog.
For more information, see Webhooks in the Buildkite documentation.
After you are connected, you can perform tasks for Buildkite directly from the Kore.ai application and setup message notifications to get notified in the Kore.ai application when an event occurs in Buildkite.
The following table describes Buildkite tasks that you can integrate with Kore.ai.
|TASK||TO CONFIGURE THIS TASK…|
|Cancel Build||In the Perform Task dialog,
In a space room, you can enter the @buildkite cancelbuild Bot command to invoke and configure this task.
|Rebuild||In the Perform Task dialog,
In a space room, you can enter the @buildkite rebuild Bot command to invoke and configure this task.
|Start Build Process||In the Perform Task dialog,
In a space room, you can enter the @buildkite startbuild Bot command to invoke and configure this task.
You can setup message notifications to your Kore.ai account using a Buildkite webhook. Click , click Get notified when…, click Event Updates via Webhook, and then in the Setup Task dialog:
- click the Activate button to generate a Webhook URL.
- copy and save the URL, or click Email Instructions to send the URL to an email account. For more information, see Configuring Buildkite Webhooks.
- optionally customize the Task Name
- optionally customize the Short Description
- enable or disable Mute task notifications.
After the webhook is configured in Buildkite, when any of the events occur in Buildkite, a message is displayed on the Bots tab in the Messages section for the Kore.ai account.