# 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="/files/xynfz2Ht8EpsTKnAcg6l" 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="/files/tNKwHBumPmpE1THDy0hv" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

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

<figure><img src="/files/yPQMbNZATkALyuUoRj8P" 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.

![](/files/0UUqRkbbyXDzHsDeNiO7)<br>
{% endstep %}

{% step %}

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

<figure><img src="/files/vvy6FR8uMrJz7rIs7ClX" 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>


---

# Agent Instructions: 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:

```
GET https://docs.birdie.so/birdie-docs/helpdesk/freshchat/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.