> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Jenkins Webhook Setup Guide

> Configure Jenkins to deliver events to StackOne.

## Prerequisites

The connector should already be set up, with a Connector Profile and a Linked Account. See [Getting Started](https://docs.stackone.com/connectors/jenkins.md#getting-started) on the Jenkins connector page.

## Install the Notification plugin

The Notification plugin (by Tikal Knowledge) sends a JSON message for each phase of a build. Install it once on your Jenkins controller.

**1. Open the plugin manager**

Sign in to Jenkins as an administrator.

<ul>
  <li>Click **Manage Jenkins** (the gear icon in the top-right corner).</li>
  <li>Under **System Configuration**, click **Plugins**.</li>
</ul>

![Manage Jenkins page with the gear icon and the Plugins entry highlighted](https://mintcdn.com/stackone-60/wCgH43op2c8xMkFb/connectors/jenkins/images/events-manage-plugins.png?fit=max\&auto=format\&n=wCgH43op2c8xMkFb\&q=85\&s=345a45f675229c588f036948af8b1d3f)

**2. Install the plugin**

Install the Notification plugin from the Jenkins plugin catalog. Jenkins loads it without a restart.

<ul>
  <li>Click **Available plugins**.</li>
  <li>In **Search available plugins**, type `notification`.</li>
  <li>Select the **Notification plugin** (plugin ID `notification`).</li>
  <li>Click **Install**.</li>
</ul>

![Available plugins tab with the search box and the Install button highlighted](https://mintcdn.com/stackone-60/wCgH43op2c8xMkFb/connectors/jenkins/images/events-available-plugins.png?fit=max\&auto=format\&n=wCgH43op2c8xMkFb\&q=85\&s=c813a6832ec91c54043c22c72151d9e1)

**3. Confirm the plugin is installed**

Check that the plugin is active before you configure any job.

<ul>
  <li>Click **Installed plugins**.</li>
  <li>Check that **Notification plugin** is listed and enabled.</li>
</ul>

![Installed plugins tab showing the enabled Notification plugin](https://mintcdn.com/stackone-60/wCgH43op2c8xMkFb/connectors/jenkins/images/events-installed-plugins.png?fit=max\&auto=format\&n=wCgH43op2c8xMkFb\&q=85\&s=2ed75dd50fa95f956c2d03eb1e1ee6f3)

## Send build events to StackOne

Add the StackOne Native Webhook URL as a notification endpoint on every job that should send events. Jobs without the endpoint send nothing.

**1. Retrieve StackOne Native Webhook URL**

The **Native Webhook URL** is generated once an account has been linked.

<ul>
  <li>Open the linked account in StackOne.</li>
  <li>Copy the value from **Native Webhook URL**.</li>
  <li>The URL contains a secret token that authenticates deliveries, so store it securely and do not share it.</li>
</ul>

**2. Open the job configuration**

Open each job that should send events to StackOne.

<ul>
  <li>Open the job in Jenkins.</li>
  <li>Click **Configure**.</li>
</ul>

![Job page with the Configure link highlighted](https://mintcdn.com/stackone-60/wCgH43op2c8xMkFb/connectors/jenkins/images/events-job-configure.png?fit=max\&auto=format\&n=wCgH43op2c8xMkFb\&q=85\&s=bf6d07069e5a8722e789b34979873ed0)

**3. Add a notification endpoint**

Add an endpoint to the job's notification settings.

<ul>
  <li>Click **Job Notifications**.</li>
  <li>Under **Notification Endpoints**, click **Add Endpoint**.</li>
</ul>

![Job configuration with the Job Notifications section and the Add Endpoint button highlighted](https://mintcdn.com/stackone-60/wCgH43op2c8xMkFb/connectors/jenkins/images/events-add-endpoint.png?fit=max\&auto=format\&n=wCgH43op2c8xMkFb\&q=85\&s=8364fa9ee7e4db706d5e21112d1e6674)

**4. Configure the endpoint**

Point the endpoint at StackOne.

<ul>
  <li>Set **Format** to **JSON**.</li>
  <li>Set **Protocol** to **HTTP**.</li>
  <li>Set **Event** to **All Events**.</li>
  <li>Leave **URL Source** as **Plain Text** and paste the Native Webhook URL into **URL**.</li>
  <li>Click **Save**.</li>
  <li>Repeat these steps for each job that should send events.</li>
</ul>

![Notification endpoint form with Format, Protocol, Event, URL and Save highlighted and the URL token masked](https://mintcdn.com/stackone-60/wCgH43op2c8xMkFb/connectors/jenkins/images/events-endpoint-settings.png?fit=max\&auto=format\&n=wCgH43op2c8xMkFb\&q=85\&s=74cc90ecf0b97113441090606fbde2ac)

## Available webhook events

The following Jenkins events can be enabled. Only events selected in StackOne are delivered; Jenkins sends every phase to the endpoint and StackOne ignores the ones that are not enabled.

**1. Build events**

Events for each phase of a build of a job that has the StackOne endpoint.

<ul>
  <li>**Build Queued** (`QUEUED`) — Fired when a build starts running, carrying the time it entered the queue.</li>
  <li>**Build Started** (`STARTED`) — Fired when a build starts running.</li>
  <li>**Build Completed** (`COMPLETED`) — Fired when a build finishes running, with its result (`SUCCESS`, `UNSTABLE`, `FAILURE`, `NOT_BUILT` or `ABORTED`).</li>
  <li>**Build Finalized** (`FINALIZED`) — Fired when Jenkins has fully written the build record after post-build steps, with the final result.</li>
</ul>

**2. Verification**

Lets a Pipeline confirm that a job is connected to StackOne.

<ul>
  <li>**Webhook Verification** (`NONE`) — Fired when a Pipeline runs the `notifyEndpoints` step with phase `NONE`. It is acknowledged and no build event is created.</li>
</ul>

## Delivery format

Details of how the Notification plugin delivers events to StackOne.

**1. One request per build phase**

Each build sends a separate JSON request for each phase, so a normal build produces four events. The phase is in `build.phase` and the result, once known, in `build.status`. The plugin does not retry failed deliveries unless retries are set on the endpoint, and it ignores the HTTP status that StackOne returns.

## Verify

Your Connector should now be able to receive and process events. Try triggering an event and you should see an Event appear in the Connector logs.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.