For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

1

Access Octadesk

Log in to your Octadesk account.

2

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.

3

Retrieve your Subdomain

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

Your account subdomain will be displayed there.

4

Retrieve your username

Your username is the email address associated with your Octadesk account.

5

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.

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

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.

References

Last updated