> For the complete documentation index, see [llms.txt](https://docs.chatlayer.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.chatlayer.ai/integrateandcode/app-integrations/topdesk.md).

# Topdesk

If your company already uses Topdesk as the customer support provider, you can easily use this app to create, update and retrieve incidents. Here are some instructions.

{% hint style="danger" %}
This integration is deprecated since 16/09/2025. If you would like to use the Topdesk intergation, please [reach out to us](/support/get-in-touch.md).
{% endhint %}

### Connect an account

To connect an account, go to the initial page and to Integrations on the left-side menu. Pick Topdesk integration and click '+Add account':

<figure><img src="https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FKx1I32uq00a2sqOV1b7J%2Fimage.png?alt=media&amp;token=92abd713-b96d-467b-8b55-2155935100d4" alt=""><figcaption></figcaption></figure>

This pop-up will appear. Fill it in with your user Topdesk account and user details:

<figure><img src="https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FPMnlMMI2XvvoRKDDP5YI%2Fimage.png?alt=media&amp;token=0e825b5c-7169-45fa-9822-355cb1af97c9" alt=""><figcaption></figcaption></figure>

Once it's done, you'll be able to see it in the list of connected accounts:

<figure><img src="https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FZdmhaQjwW3hPX7F4cG8A%2Fimage.png?alt=media&amp;token=81543e50-1432-41db-8fb8-041e1fb767ba" alt=""><figcaption></figcaption></figure>

### Creating an incident

Add an Action block and search for Topdesk at the App menu

<figure><img src="https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FWGEnsVAoNkjEC7bMJWA7%2Fimage.png?alt=media&amp;token=d7ece7e2-a731-44ff-9276-a5fdbacd05e3" alt=""><figcaption></figcaption></figure>

If you followed the previous steps, your account should be connected. Otherwise, you can create the account from this step:

<figure><img src="https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FctSydR6yxGuzhCkXh6rX%2Fimage.png?alt=media&amp;token=f3919e82-092e-4c5c-88bc-ea5a972ce205" alt=""><figcaption></figcaption></figure>

In the action fields you can fill in the variables that contain the data about the person creating the incident and what their request is about.

<figure><img src="https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FPDf31TeplhjL4dd9Lh6K%2Fimage.png?alt=media&amp;token=52fe53ab-7eac-484e-83c5-18edf7ffb5b5" alt=""><figcaption></figcaption></figure>

The fields 'type', 'category', 'subcategory' and 'operator group' have drop-down lists that are available from your account. Alternatively, you can get those inputs directly from the user and save them as variables or choose which fields are really mandatory to your bot:

<figure><img src="https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FSCZAOR3meJn4nxWUSbyw%2Fimage.png?alt=media&amp;token=234fdb46-d08d-489d-a3f5-22753c3b6d8b" alt=""><figcaption></figcaption></figure>

To show the user the number of the incident that was created, you can use the internal variable `{apps.topdesk.create_incident.number}` as shown below:

<figure><img src="https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FfzKTC65wxVLNJW2ahbBJ%2Fimage.png?alt=media&amp;token=3fe66c4a-183a-4e25-b9b2-0f2a468a0f44" alt=""><figcaption></figcaption></figure>

### Update incident

To update an incident, you just need to follow the previous instructions and choose the 'update incident' action.

<figure><img src="https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FpA3FhyK14y95euBA2ZWd%2Fimage.png?alt=media&amp;token=591a1f5f-55cb-4cdd-8bd0-822a5944b529" alt=""><figcaption></figcaption></figure>

You can show the user the incident and status of it by using the internal variables:`{apps.topdesk.create_incident.number}`, `{apps.topdesk.update_incident.processingStatus.name}`

<figure><img src="https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FTa4ycveSuMk0mGHmoiBP%2Fimage.png?alt=media&amp;token=534f2db2-97e5-4587-abb0-5669bf152d11" alt=""><figcaption></figcaption></figure>

Now you're ready to create a great customer support bot, integrated with TopDesk!


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.chatlayer.ai/integrateandcode/app-integrations/topdesk.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
