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

Ada Playbook

Add Birdie to your Ada conversations

To add Birdie into your Ada Playbooks, follow these steps.

Installation

Go to Settings => Helpdesk to enable Ada. Once enabled, you'll get access to the informations you will need in order to wire Birdie Recordings into the bot conversations.

1. Get the Conversation ID

1

Create a New Action

Go to the Actions in the left menu and create a New Action. Give it a name, here we will use [Birdie] Get conversation_id

2

Setup Connect to API

Scroll down to Connect to API section and fill-in the fields as described: Let the default GET method on the right. In the Request Block URL field, use https://<your-ada-subdomain>.ada.support/api/conversations/recent/chat/ <chatter_token> Replace <your-ada-subdomain> by your current subdomain (you can find it in the url of any of your Ada pages). And replace <chatter_token> by the red chatter_token placeholder proposed by Ada as illustrated in the following screenshot. Switch to the Headers tab and add a Header field, name it Session-Auth and pull the red chatter_session_token placeholder into the value (see screenshot above).

3

Use API outputs in chat

Scroll down to Use API outputs in chat section and fill-in the fields as described: Output name: Conversation ID Path: conversations[0]._id Check the 2 options Give my AI Agent access to this information, and Save output as a variable. Create a new variable named conversation_id and add it following the example in this screeshot:

4

Save

Don't forget to Save (upper right button)

1

Create a New Action

Go to the Actions in the left menu and create a New Action. Give it a name, here we will use [Birdie] Retrieve Recording Link

2

Setup Connect to API

Scroll down to Connect to API section and fill-in the fields as described: Let the default GET method on the right. In the Request Block URL field, use this URL: https://app.birdie.so/api/v1/ada/get_recording_link?conversation_id=<conversation_id> and make sure to replace <conversation_id> by your Ada variable conversation_id

Also add the 2 headers provided in your Birdie Ada Setup page, as you can see in the floowinf screenshot.

3

Use API outputs in chat

Scroll down to Use API outputs in chat and save the Response as a variable, recording_link as illustrated into this screeshot:

3. Create the Playbook (v2)

Now the 2 actions are ready, you can instruct Ada to request recordings: use the first action to get the conversation id, optionnally get the user email, provide a request link, and wait for the user to finish the recording. Once the recording is done, use the second action to fetch the recording and present it into the conversation.

Here is a full example as a screenshot. For the first clickable link, go to your Birdie Ada's integration settings to get your link, essentially replacing your-domain.birdie.so in that playbook with your own domain.

4. Done

Don't forget to Save your Playbook!

Last updated