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

# Octadesk

### Overview

This integration imports conversations from your Octadesk account into Birdie, allowing customer interactions to be analyzed within the Birdie platform.

In order to authorize the Birdie integration to collect data from your Octadesk account, you must provide valid API credentials.

### Requirements

To set up this integration, you’ll need:

* An API Token
* Your Octadesk subdomain
* The email address associated with your Octadesk user

To retrieve these credentials, follow the instructions below:

### Setup in OctaDesk

{% stepper %}
{% step %}

#### Access Octadesk

Log in to your Octadesk account.
{% endstep %}

{% step %}

#### Generate an API Token

Navigate to the "Integration Code" section.

Then, click "Create your first API token", provide a name for the token, and copy the generated API Token.
{% endstep %}

{% step %}

#### Retrieve your Subdomain

Click on your profile name in the bottom-left corner of the application.

Your account subdomain will be displayed there.
{% endstep %}

{% step %}

#### Retrieve your username

Your username is the email address associated with your Octadesk account.
{% endstep %}

{% step %}

#### Securely Share Credentials

Once you have access to your credentials:

* API Token
* Subdomain
* Username

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

After completing the setup above and securely sharing the required credentials, the Birdie team will configure the connector and confirm when the integration is active.

### API Considerations

Revoking or regenerating the API token will interrupt data synchronization until the new credentials are shared with Birdie.

For more details about API, refer to the official [documentation](https://help.octadesk.com/a/como-trabalhar-com-a-api-da-octadesk)

### Data in scope

#### Import Process and Update Frequency

Birdie periodically retrieves the most recently updated records from Octadesk and imports their associated metadata. This process runs on a regular schedule to ensure customer interactions remain up to date within the platform.

#### Custom fields

If your Octadesk setup includes custom fields, these fields can be imported into Birdie, preserving your existing data structure and business context. They allow you to capture additional information beyond the standard conversation data.

Once imported, these fields become available as custom fields in Birdie, enabling enhanced segmentation, filtering, and deeper analysis across customer interactions.

For more details about custom fields in Octadesk, refer to the official [documentation](https://help.octadesk.com/a/como-configurar-e-utilizar-campos-personalizados-nas-conversas).

### References

* [Octadesk General Documentation](https://help.octadesk.com/)
* [Octadesk Developer Documentation](https://developers.octadesk.com/)


---

# 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/octadesk.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.