# Jira

The steps below describe how to create an outgoing webhook in Apono that will allow to automatically create issues in Jira from Apono access requests.

***

### Create Jira ticket triggered by Apono webhook

You can automatically create and resolve issues in Jira via outgoing webhooks. This guide provides example webhook configurations for common use cases, as well as information on how to set up a user in Jira to be used by Apono.

***

### Prerequisites

1. A user in Jira to be used by Apono. You'll need the user's email address.
2. An [API token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/#Create-an-API-token) for this user. These credentials will be used to communicate with Jira REST API.
3. Make sure the user has appropriate permissions to create and update issues in Jira.

{% hint style="info" %}
**What are Jira Basic tokens?**

Read more [here](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/)
{% endhint %}

***

### Creating the webhook

Follow these steps to configure an Apono webhook:

1. On the [**Webhooks**](https://app.apono.io/webhooks) page, click **Add Webhook**. The **Add Webhook** page appears.
2. Click **Request Webhook**.
3. Enter a unique, alphanumeric, user-friendly **Request Webhook Name** for identifying this webhook.
4. Click the **Status** toggle to **Active**.
5. From the **Method** dropdown menu, select a REST method.
6. In the **URL** field, enter *https\://\<DOMAIN>.atlassian.net/rest/api/3/issue*.\
   \
   Be sure to replace `<DOMAIN>` with your Jira domain.

{% hint style="warning" %}
The webhook URL **must adhere** to the following requirements:

* Uses the HTTPS protocol
* Does **not** specify any custom ports
  {% endhint %}

7. In the **Body Template** field, construct a JSON body for the webhook payload.

```json
{
   "fields": {
      "project": {
         "key": "<PROJECT_KEY>"
      },
      "issuetype": {
         "name": "<ISSUE_TYPE_NAME>"
      },
      "summary": "Apono request created: {{ data.friendly_id }}"
   }
}
```

{% hint style="success" %}
Click **View event's payload schema** to reveal the payload schema and available data fields. You can also refer to the [Webhook Payload Schema Reference](https://docs.apono.io/docs/webhook-integrations/webhook-payload-references/webhook-payload-schema-reference) to read the descriptions of each data field.
{% endhint %}

8. Under **Headers**, use the following **Key** and **Value** to set the headers required by the target system, such as an authorization header.

<table><thead><tr><th width="230">Key</th><th>Value</th></tr></thead><tbody><tr><td><em>Authorization</em></td><td><em>Basic &#x3C;USERNAME:TOKEN></em><br><br>The username is the user's email and token is the personal API token required in Prerequisites 1 and 2. <code>&#x3C;USERNAME:TOKEN></code> must be supplied in <a href="https://www.base64encode.org/">base64 encoding</a>.</td></tr></tbody></table>

9. From the **Triggers** dropdown menu, select one or more of the following event triggers, which correspond to Apono access request statuses:
   * **RequestCreated**
   * **RequestApproved**
   * **RequestExpired**
   * **RequestFailed**
   * **RequestGranted**
   * **RequestRejected**
10. Under **Filters**, define one or several filter from the listed dropdown menus.

{% hint style="info" %}
Filters empower admins to control the data transmitted via webhooks, minimizing the amount of data third-party tools receive and reducing unnecessary clutter.

**Examples**:

* Send only production requests to your admins' Slack channel.
* Trigger Okta workflows for events from specific integrations or resource types.
* Open a ticket in Jira or ServiceNow for manually approved requests.
  {% endhint %}

11. (Optional) In the **Timeout in seconds** field, enter the duration in seconds to wait before marking the request as failed.
12. (Optional) Define **Response Validators** to verify that the response from the webhook meets specified criteria:
    1. Click **+ Add**. A row of settings appears.
    2. Starting with *$.data.*, enter the **Json Path** of the JSON parameter.
    3. In the **Expected Values** field, enter a value and press the Enter key on your keyboard.
    4. Repeat step **c** to add several expected values.
    5. Repeat steps **a-d** to add multiple response validators.
13. Click **Test** to generate a test event to trigger your webhook. A **Test successful** or **Test failed** response status will appear at the bottom of the page. A successful test will send mock data to the target system.

{% hint style="success" %}
For more information about the test, click **View Invocation Data**. A panel opens revealing the request, response, and other relevant details.

Should your test fail, view these tips to [troubleshoot your webhook](https://docs.apono.io/docs/webhook-integrations/troubleshoot-a-webhook).
{% endhint %}

14. Click **Save Webhook**.

The new webhook appears in the **Webhooks** table. Active webhooks are preceded by a green dot. Inactive webhooks are preceded by a white dot.

Apono access request logs will be sent to Jira based on the triggers you have selected.

***

### Results

Your webhook should now start creating Jira tickets in the relevant project once triggered:

![](https://files.readme.io/7f7b89e-image.png)

![](https://files.readme.io/249f249-image.png)