# Delighted

### Overview

Birdie allows you to automatically ingest responses from your Delighted surveys into your workspace, enabling deeper analysis and insight generation through our VoC intelligence platform. This integration captures not only survey answers but also associated metadata like respondent, company, and channel information.

With this integration, you’ll be able to:

* Import NPS/CSAT survey responses from Delighted
* Capture associated metadata (e.g., user info, company, timestamps, tags)
* Automatically sync data into Birdie for analysis

Below is a step-by-step guide to help you set up your Delighted → Birdie integration using the Delighted REST API.

### Requirements

Birdie's integration with Delighted requires the API token for your project. Delighted works as a platform where you can create multiple projects. Each project corresponds to a survey, and Birdie needs the API token associated with the specific project you want to integrate.

To retrieve the API Key, follow the instructions below:

{% stepper %}
{% step %}

### Select Project

* Log in to your Delighted account and select the correct project (top-left corner).

<figure><img src="https://2659701720-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN7EEIMhL4xEKWM6BDyEL%2Fuploads%2FTHQDIStd70QlKkns92ti%2Fimage.png?alt=media&#x26;token=895b17b1-1ebc-4e8f-b78b-ea0258f45647" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Access API Documentation

* Go to Help > API Docs to find your private key (top-right corner).

<figure><img src="https://2659701720-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN7EEIMhL4xEKWM6BDyEL%2Fuploads%2FmloDYlKdKtpBfDe96U19%2Fimage.png?alt=media&#x26;token=12c6bf3a-2b1d-4ea4-b2c7-09b6c775cb31" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Get Your API Key

* In the authentication section, you will find your API key.

<figure><img src="https://2659701720-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN7EEIMhL4xEKWM6BDyEL%2Fuploads%2FjqBsDQWEfkl5onlqeNCQ%2Fimage.png?alt=media&#x26;token=7fa646dd-28fe-4c05-90fc-cbe722419d2b" alt=""><figcaption></figcaption></figure>

* Once you have access to your API key, share it with us following our guide: [Securely Sharing Credentials for Data Integration](https://ask.birdie.ai/integrations-and-data-ingestion/securely-sharing-credentials-for-data-integration).

{% hint style="warning" %}
Your API key is sensitive. Never share it publicly. It will be used via HTTP Basic Authentication as the username, leaving the password field blank.
{% endhint %}
{% endstep %}
{% endstepper %}

### Connect to Birdie

After completing the setup above and sharing your Delighted API key securely, the Birdie team will configure the connector and confirm when the integration is active.

#### Rate Limiting Considerations

In rare cases, Delighted may temporarily limit API requests (for example, if too many requests are made in a short time).

If this happens, some requests may fail briefly and access usually returns to normal shortly.

You don’t need to take action unless the rate limit persists.

#### Import Process and Update Frequency

Birdie imports the most recently updated survey responses from Delighted 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.

#### Custom Fields

If your Delighted setup includes custom fields for survey responses, these fields can be mapped directly into Birdie, preserving your unique data structure. For survey responses, the data follows this [response pattern](https://app.delighted.com/docs/api/listing-survey-responses)

Once imported, Delighted custom fields appear as Birdie custom fields, maintaining consistency across both platforms. Mapped to Birdie’s data structure, these fields enhance data organization and filtering, supporting extended segmentation within Birdie’s interface. This allows for customized workflows and data displays based on the unique attributes of each survey response.

If you need further help, contact your Birdie representative or Delighted admin for project-specific assistance.

### References

* Delighted API Documentation\
  <https://app.delighted.com/docs/api>