> For the complete documentation index, see [llms.txt](https://docs.apono.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apono.io/docs/webhook-integrations/manual-webhook/validate-tickets-with-webhooks.md).

# Validate tickets with webhooks

Many organizations require that every access request corresponds to a valid ticket in their IT Service Management (ITSM) platform, such as Jira, ServiceNow, or Zendesk.

Apono’s webhook integration allows you to validate ticket IDs automatically before a request is submitted, ensuring that all requests are auditable, compliant, and properly linked to existing incidents or stories.

When this feature is enabled, end users are prompted to enter a ticket ID in the access request form. A webhook checks the ticket’s validity against your ITSM system before submission is allowed.

***

### Prerequisites

<table><thead><tr><th width="220.05859375">Item</th><th>Description</th></tr></thead><tbody><tr><td><strong>ITSM user account</strong></td><td><p>Service account or user profile in your ITSM platform with permissions to read ticket or incident data</p><p>This user will be used by Apono to verify whether the provided ticket ID exists.</p></td></tr><tr><td><strong>Ticket ID field setup</strong></td><td><p>Ticket ID enablement for your Apono account</p><p>Contact Apono Support to enable a ticket ID custom field in your account.</p><p>Apono Support requires the following information to enable the custom field for your request forms:</p><ul><li>Preferred field name to appear in the Apono UI (such as <em>Ticket ID</em>)</li><li>Preferred field parameter (such as <code>ticket_id</code>)</li></ul></td></tr><tr><td><strong>API authentication token</strong></td><td><p>API token or credential for your ITSM user</p><p>See your ITSM documentation for more information:</p><ul><li><a href="https://support.freshdesk.com/support/solutions/articles/215517">Freshdesk</a></li><li><a href="https://api.freshservice.com/#authentication">Freshservice</a></li><li><a href="https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/#Create-an-API-token">Jira</a></li><li><a href="https://www.manageengine.com/products/service-desk/sdpop-v3-api/">ServiceDesk Plus</a></li><li><a href="https://support.servicenow.com/kb?id=kb_article_view&#x26;sysparm_article=KB0778194">ServiceNow</a></li><li><a href="https://developer.zendesk.com/api-reference/introduction/security-and-auth/#api-token">Zendesk</a></li></ul><p>If using Basic authentication, you must encode your credentials in Base64 format, such as the following: <code>Basic &#x3C;base64encoded(email:api_token)></code></p><p><br>Learn how to <a href="http://base64encode.org">generate the encoded string</a> in Base64.</p></td></tr></tbody></table>

***

### Configure a webhook

<figure><img src="/files/4H1rPtlDpAJOlwnyXRDU" alt="" width="375"><figcaption><p><em>Add Webhook page</em></p></figcaption></figure>

Follow these steps to configure an Apono webhook to validate your ITSM tickets:

1. On the [**Webhooks**](https://app.apono.io/webhooks) page, click **Add Webhook**. The **Add Webhook** page appears.
2. Click **Manual**.
3. Enter a unique, alphanumeric, user-friendly **Manual Webhook Name** for identifying this webhook.
4. Click the **Status** toggle to **Active**.
5. From the **Type** dropdown menu, select **HTTP Webhook**.
6. From the **Method** dropdown, select **GET** or **POST**, depending on your ITSM API requirements.
7. In the **URL** field, enter the route for your ITSM’s ticket or incident lookup API, using the format below. Be sure to replace `<YOURDOMAIN>` with your ITSM domain.

{% hint style="info" %}
The webhook URL must meet the following requirements:

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

```
https://<YOURDOMAIN>/rest/api/3/issue/{{data.custom_fields.ticket_id}}
```

8. In the **Body Template** field, construct an empty JSON body for the webhook payload.

```
{}
```

9. In the **Headers** section, add your ITSM Basic authentication token.

{% hint style="warning" %}
Ensure your token or key has sufficient permission to read ticket data. If your ITSM supports bearer tokens (such as ServiceNow or Zendesk), replace `Basic` with `Bearer`.
{% endhint %}

| Key             | Table                     |
| --------------- | ------------------------- |
| *Authorization* | *Basic \<ENCODED\_TOKEN>* |

10. From the **Authentication Type** dropdown menu, select **None**.
11. (Optional) From the **Triggers** dropdown menu, select one or more triggers for the webhook. By default, **Manual** is selected.
12. (Optional) In the **Timeout in seconds** field, enter the duration in seconds to wait before marking the request as failed.
13. (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.
14. In the **Custom Validation Error Message** field, add a clear message to be displayed to end users if the webhook fails (such as, *The ticket ID you entered could not be validated*).
15. Click **Save Webhook**.

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

Apono notifications will be sent to your target system when the status of an integration has changed to a warning or error state.

#### Usage

Now that the webhook is configured, you can add it as a custom approver to an access flow, so that the webhook automatically checks a ticket’s validity before access approval is submitted.

Follow these steps to add the webhook to an access flow:

1. [Create a self-serve access flow](https://docs.apono.io/docs/access-flows/creating-access-flows-in-apono/self-serve-access-flows).
2. When [setting up custom approval](https://docs.apono.io/docs/access-flows/creating-access-flows-in-apono/self-serve-access-flows#set-up-custom-approval), select **Custom Approval** as the approver attribute (step **3**) and your newly configured webhook as the value (step **5**).
3. Click **Save**.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.apono.io/docs/webhook-integrations/manual-webhook/validate-tickets-with-webhooks.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.