> For the complete documentation index, see [llms.txt](https://ask.birdie.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ask.birdie.ai/integrations-and-data-ingestion/how-to-integrate-with/asknicely.md).

# AskNicely

### Overview

This integration imports AskNicely survey responses into Birdie so they can be analyzed alongside other feedback sources. The connector currently supports **NPS** and **CSAT** responses and maps them into Birdie Feedback.

### Requirements

To connect AskNicely to Birdie, you need:

* **AskNicely base URL**: the URL you use to access AskNicely in your browser (must include `https://`).
* **AskNicely API key**: AskNicely authenticates API requests via a per-user API key.

{% hint style="info" %}
We recommend creating a dedicated AskNicely user for Birdie and use that user’s API key.
{% endhint %}

### Setup in AskNicely

{% stepper %}
{% step %}

#### Find your AskNicely base URL

1. Log in to AskNicely.
2. Copy the full URL from your browser address bar.
3. Use that as the **base URL** in Birdie (including `https://`).
   {% endstep %}

{% step %}

#### Generate an API key

AskNicely API requests are authenticated using the `X-apikey` header.

1. Log in to **AskNicely**.
2. Go to **Settings**.
3. Open **Users**.
4. Select the user that will be used for the Birdie integration (or create a dedicated user).
5. Copy the API key for that user.

Once you have access to your API key, share it with us following our guide: [Securely Sharing Credentials for Data Integration](/integrations-and-data-ingestion/securely-sharing-credentials-for-data-integration.md).
{% endstep %}
{% endstepper %}

### Connect to Birdie

Provide the following to Birdie (share credentials via a secure, one-time channel):

* `domain`: AskNicely base URL (must include scheme, e.g. `https://…`)
* `api_key`: AskNicely API key

### Import Process and Update Frequency

Birdie imports the most recently updated survey responses from AskNicely and then retrieves their metadata. This process runs on a regular schedule, ensuring that the latest interactions and content are consistently reflected in the application.

### Data in scope

#### Custom fields

The integration will retrieve additional fields from the AskNicely API, these fields can be mapped directly into Birdie, preserving your unique data structure.

Once imported, AskNicely fields appear as Birdie custom fields, maintaining consistency across all platforms and enabling enhanced segmentation, filtering, and custom workflows in Birdie.

### References

* [AskNicely API Documentation](https://demo.asknice.ly/help/apidocs/)


---

# 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://ask.birdie.ai/integrations-and-data-ingestion/how-to-integrate-with/asknicely.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.