ByteChef LogoByteChef
Components

Jenkins

Jenkins is leading open source automation server, Jenkins provides hundreds of plugins to support building, deploying and automating any project.

Categories: Developer Tools

Type: jenkins/v1


Connections

Version: 1

basic_auth

Properties

NameLabelTypeDescriptionRequired
usernameUsernameSTRINGJenkins username.true
passwordAPI TokenSTRINGJenkins API token.true
baseUriBase URISTRINGComplete base URI of your jenkins server.true

Actions

Create Job

Name: createJob

Creates a new job.

Properties

NameLabelTypeDescriptionRequired
nameNameSTRINGName of the job.true
configXmlConfig XMLSTRINGContent of the config.xml file.true

Example JSON Structure

{
  "label" : "Create Job",
  "name" : "createJob",
  "parameters" : {
    "name" : "",
    "configXml" : ""
  },
  "type" : "jenkins/v1/createJob"
}

Output

This action does not produce any output.

Triggers

New Job Status Notification

Name: newJobStatusNotification

Triggers when job statuses are changed.

Type: STATIC_WEBHOOK

Output

Type: OBJECT

Properties

NameTypeDescription
nameSTRINGName of the Jenkins job.
display_nameSTRINGDisplay name of the Jenkins job.
urlSTRINGURL of the Jenkins job.
buildOBJECT
Properties {STRING(full_url), INTEGER(number), INTEGER(queue_id), NUMBER(timestamp), INTEGER(duration), STRING(phase), STRING(url), {[](changes), [](culprits)}(scm), STRING(log), STRING(notes), {}(artifacts)}
Jenkins job build.

JSON Example

{
  "label" : "New Job Status Notification",
  "name" : "newJobStatusNotification",
  "type" : "jenkins/v1/newJobStatusNotification"
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.


Additional Instructions

Connection Setup

Create Jenkins API Token

  1. Click on Manage Jenkins icon.
  2. Click on Users.
  3. Click this icon on the user you want to create the API token for.
  4. Click on Security.
  5. Click on Add new token.
  6. Enter name of the token and then click on Generate.
  7. Copy token, you will not be able to see the whole token again.
  8. Click on Done.

Trigger Setup

Enable Notification Plugin

  1. Click this icon.
  2. Click on Plugins.
  3. Click on Available plugins.
  4. Search for notification.
  5. Click on Notification from Tikal Knowledge. Notification plugin link
  6. Click here.
  7. Click on Install.
  8. Wait for everything to finish downloading.
  9. Click on Go back to the top page.

Trigger URL Setup

  1. Select Jenkins job to which you want to connect the trigger to.
  2. Click this Configure.
  3. Click on Add Endpoint.
  4. Paste Webhook URL. See Deploy documentation on how to get Webhook URL.
  5. Click on Save.