# Installation

{% hint style="info" %}
If you need help or have a question, contact us at <support@birdie.so>
{% endhint %}

{% stepper %}
{% step %}

### Install Birdie from [Freschat Marketplace](https://www.freshworks.com/apps/freshchat/screen_recording_by_zest/) [→](https://www.freshworks.com/apps/freshchat/screen_recording_by_zest/)

{% endstep %}

{% step %}

### Enter your Freshchat account subdomain in the first field and your API Key in the second field.

<figure><img src="https://3843507234-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FECPgvsGwy5oMz4WIZw3a%2Fuploads%2FLqu11dZGaWHgwvRmBUvN%2Finstallation%20freshchat%20api.png?alt=media&#x26;token=9272653a-13c5-4b90-ab9e-9b4efee0ce52" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Find Your Freshchat Identifier

1. **If your Freshchat workspace URL looks like:**\
   `https://yourcompany.freshchat.com`\
   → Your identifier is the subdomain (`yourcompany`) in your workspace URL.
2. **If your Freshchat workspace URL looks like:**\
   `https://yourcompany.myfreshworks.com`\
   → Go to **Settings** → **Admin Settings** → **Conversation Mobile App** and locate the **Domain ID**.

<figure><img src="https://3843507234-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FECPgvsGwy5oMz4WIZw3a%2Fuploads%2F1hhxxsL5TRXmGCOJ0zsc%2Ffreshchat%20x%20birdie%20doc%20Domain%20ID.gif?alt=media&#x26;token=59f60499-aee0-4449-b369-526335819251" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Find your API keys in your Profile Settings:

<figure><img src="https://3843507234-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FECPgvsGwy5oMz4WIZw3a%2Fuploads%2FPkMa3u6DfUfHa2n2kJKi%2Ffreshchat%20installation.gif?alt=media&#x26;token=caf619bd-0db8-4a13-acd5-9059fb7a73a9" alt=""><figcaption><p>Copy your API key</p></figcaption></figure>
{% endstep %}

{% step %}

### Connect the Birdie App to Your Workspace

After installing the app, you still need to <mark style="color:green;">`Connect`</mark>  it to your Birdie workspace:

* **If you already have a Birdie workspace:** Sign in using the same email address linked to your workspace.
* **If you don’t have a Birdie workspace yet:** Create one using your professional email.

![](https://3843507234-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FECPgvsGwy5oMz4WIZw3a%2Fuploads%2FPEcBpmUpR2JmPakDKSRb%2Ffreshchat%20x%20birdie%20doc%20Connect.gif?alt=media\&token=2cc05b27-e12f-4fae-83cc-5d6601780eb4)<br>
{% endstep %}

{% step %}

### You can now use the app&#x20;

<figure><img src="https://3843507234-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FECPgvsGwy5oMz4WIZw3a%2Fuploads%2FKyOvqo6Alq80wURXJyRn%2Fconnect%20birdie%20workspace%20freshchat.png?alt=media&#x26;token=05a3ac76-2bb0-41b3-89f5-fd7200ee3c54" alt=""><figcaption><p>Connect the Birdie app to your Birdie workspace</p></figcaption></figure>

{% endstep %}
{% endstepper %}

<details>

<summary>What happens if IP restrictions are enabled?</summary>

Just allow the following IPs: <mark style="color:green;">`18.189.92.93`</mark> and <mark style="color:green;">`3.20.198.186`</mark>&#x20;

</details>