> 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/solucx.md).

# SoluCX

### Overview

This integration connects Birdie to your **SoluCX** account so that you can import your survey data and analyze it alongside other feedback sources.

Below are key details about what we need to set up the integration and how data is imported.

### Requirements

For Birdie to connect to your **SoluCX** account and import data, the following are needed:

* Instance token
* User token
* The survey type to import: NPS or CSAT
* Optionally, the list of surveys (called journeys in SoluCX) to import

### Setup in SoluCX

{% stepper %}
{% step %}

#### Obtain the required tokens

SoluCX's documentation does not explain how to generate these tokens. Request the following from the **SoluCX support team**:

* Your instance token.
* A user token for the user that will be used by the integration.
  {% endstep %}
  {% endstepper %}

### Share Connection Details with Birdie

To configure the integration, securely provide Birdie with the following information.

```json
{
  "connection_details": {
    "api_key": "YOUR-SOLUCX-INSTANCE-TOKEN",
    "user_token": "YOUR-SOLUCX-USER-TOKEN",
    "survey_type": "nps",
    "surveys": ["JOURNEY-1", "JOURNEY-2"]
  }
}
```

| Section              | Field         | Required | Description                                                                                                    |
| -------------------- | ------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
| `connection_details` | `api_key`     | Yes      | The instance token for your SoluCX account.                                                                    |
| `connection_details` | `user_token`  | Yes      | The user token for the user that will be used by the integration.                                              |
| `connection_details` | `survey_type` | Yes      | The type of survey to import, either `nps` or `csat`.                                                          |
| `connection_details` | `surveys`     | No       | List of surveys (called journeys in SoluCX) to import. Omit to import every survey available for your account. |

[Share credentials securely](/integrations-and-data-ingestion/securely-sharing-credentials-for-data-integration.md) with the Birdie team. Never send credentials via email or unencrypted channels.

The Birdie team will configure the integration and confirm once it is active.

### Data in scope

Once configured, the SoluCX integration imports survey-related data from your SoluCX account, so it can be analyzed alongside your other feedback sources in Birdie.

#### Custom fields

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

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

### References

* [SoluCX integrations](https://docs.solucx.com.br/en/integrations/solucx-api)
  * [Authentication](https://docs.solucx.com.br/en/integrations/solucx-api#authentication-auth)


---

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