> For the complete documentation index, see [llms.txt](https://docs.ngsurvey.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ngsurvey.com/walkthroughs/zendesk-integration.md).

# Zendesk integration

Configuring ngSurvey with Zendesk to send out a survey based on your tickets can be done in following easy steps

## ngSurvey Side

On the ngSurvey start by creating your survey as you would normally do. To capture the data that will be send from Zendesk you will need to add a [Hidden question](/form-management/form-designer/questions/question-types/advanced-types/hidden-question.md) anywhere your survey.&#x20;

For the sake of this demo will capture only 2 parameters from Zendesk the ticket id and requester name, you can of course capture and use in your survey any of the available Zendesk placeholder.

To capture the parameters create 2 answers in your hidden question and set their default values to be filled from the querystring.

![](https://1025048312-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8fLhS0bmfBRyq0HdUm%2Fuploads%2FrTGTozoUE7fQNdgQSLWp%2Fimage.png?alt=media\&token=6c390779-0ffb-4800-88c5-f1f904d16cdd)  &#x20;

![](https://1025048312-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8fLhS0bmfBRyq0HdUm%2Fuploads%2FiwrbLVUIp86HfTZMHcfq%2Fimage.png?alt=media\&token=a2a239b5-bec9-47d8-8e03-af489e0ca399)

On your added these answers your hidden question will look like this.

<img src="https://1025048312-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8fLhS0bmfBRyq0HdUm%2Fuploads%2FjDvEmozLwsQxRFfMzTkc%2Fimage.png?alt=media&amp;token=c04744d8-3937-4b29-8205-dc56fd4bf87d" alt="" data-size="original">

This hidden question will capture and save the querystring values that will be filled by Zendek in the Zendesk's email send to the customer.

Once your survey is ready go to the Publish / Send screen of your survey and copy the web link of your survey. You will need this link on the Zendesk side to create the survey invitation email

&#x20;![](https://1025048312-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8fLhS0bmfBRyq0HdUm%2Fuploads%2FonpA0LNYIghetWIKkTKm%2Fimage.png?alt=media\&token=23f1115e-e8b2-49ea-89fe-9d7377ad7c2a)

## Zendesk side

Log into your Zendesk account and go to the Automation section and create a "notification automation" with the link of your survey in the notification body along the querystring parameters that you want to save in your survey.

![](https://1025048312-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8fLhS0bmfBRyq0HdUm%2Fuploads%2FW7g3vgTO2fGrfmOH0JpZ%2Fimage.png?alt=media\&token=d9482b4e-77b2-4b8a-907a-91633ffd81c0)

```
<a href="https://yoursite/s/yoursurveyuid?ticketid={{ticket.id}}&requestername={{ticket.requester.name}}">Click here to  rate us</a>
```

This will setup an automated email that will be sent out every day to solved tickets. As an alternative you could also use the Zendesk Webhook notification action along the ngSurvey [campaign trigger](/form-management/campaigns/rest-trigger.md#what-is-a-rest-trigger) to insert the the invitation into an existing ngSurvey campaign.&#x20;

{% hint style="info" %}
Using more advanced features of ngSurvey like [question embeding](/form-management/campaigns/campaign/invitation-message/embedding-a-question.md#what-is-an-embedded-question) its also possible to embed a question into your Zendesk notification body.
{% endhint %}


---

# 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.ngsurvey.com/walkthroughs/zendesk-integration.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.
