Birdie

Birdie Documentation

• What is Birdie?: Welcome! We're so glad you're here.💙
• Getting started: Get started in just 2 minutes
• Invite teammates: Invite teammates: The more, the merrier!
• Overview: Request Screen Recordings from customers.
• Installation
• Helpdesk Integrations: Which Helpdesk are you using?
• Customize Appearance: What kind of vibe are you going for?
• Custom Domain Setup: Serve request links and video recordings from your own domain instead of birdie.so. Give customers a fully branded experience they recognize and trust.
• Snippet: How to install the Birdie snippet
• Single Domain Setup: Birdie automatically captures console logs when a user records an issue.
• Multiple Domains Setup: Birdie automatically captures console logs when a user records an issue.
• Browser compatibility
• Languages: Supporting customers around the world?
• Web SDK: Open Birdie recorder from a specific button, link or element in your web app!
• Universal Request Link: This guide provides concise instructions for using our screen recording request link with any helpdesk
• DevTools: Console Logs & Network Requests: Birdie DevTools for incoming screen recordings
• How to Improve Logs Capture with Birdie
• Transcript, Captions & AI Summary: Get an instant overview of your recordings.
• Misc.
• Forward recordings: Make it work your way
• Routing rules for folders: Set up rules to automatically send recordings to the right folder
• API: Use Birdie API to access our endpoints
• How-to's Library: Create once. Use infinite times.
• Overview: Record. Share. Resolve.
• Recording Options: Customize your recording experience to capture exactly what you need
• DevTools: Console Logs & Network Requests: Birdie DevTools for outgoing screen recordings
• Keyboard Shortcuts: Ctrl + Shift + S
• Incognito Mode: Using Birdie in Incognito Mode
• Troubleshooting
• How to quickly fix common recording errors: This is a great place to start your troubleshooting. 🔧
• How to troubleshoot Microphone issues in Birdie Extension: Is your recording missing audio? Try these fixes.
• How to troubleshoot Screen Recording issues in Birdie Extension: Is your recording facing screen recording issues? Try these fixes.
• Deploy Birdie Extension Across Your Org
• Zendesk: Birdie with Zendesk
• Installation: How to install Birdie on Zendesk
• Flows: Birdie x Zendesk
• Human-Initiated Requests: Request screen recordings from customers through both the Zendesk sidebar and editor
• Zendesk Macros: Add Birdie to Zendesk Macros
• Zendesk Ticket Form: How to add Birdie to your Zendesk ticket form
• Zendesk Auto-Reply: Add Birdie to Zendesk Triggers and/or Automations
• Zendesk AI Agents: Add Birdie to your Conversation Bots
• Zendesk Agent Signature: Add Birdie to agent signatures on Zendesk
• Zendesk Widget (Classic): How to add Birdie to your Zendesk widget on your web app
• Analytics: How to Track Birdie ROI in Zendesk with a Tag
• Uninstall: Bye Bye
• Intercom: Birdie with Intercom
• Installation: How to install Birdie on Intercom
• Flows: Birdie x Intercom
• Human-Initiated Requests: Request screen recordings from customers through both the Intercom sidebar and editor
• Intercom Workflows: Add Birdie to your Intercom Operator
• FIN: Add Birdie to your custom answers in FIN
• Intercom Messenger Home: Birdie with your Intercom Messenger
• Analytics: Measure Birdie ROI
• Freshdesk: Birdie with Freshdesk
• Installation: How to install Birdie on Freshdesk
• Flows: Birdie x Freshdesk
• Human Request: Request screen recordings from customers through both the Freshdesk sidebar and editor
• Portal: How to add Birdie to your Zendesk ticket form
• Canned Answers: Add Birdie to your Canned Responses
• Auto Reply: Add Birdie to your Requester Notifications to create auto replies.
• Agent Signature: Add Birdie to agent signatures on Freshdesk
• Analytics: Measure Birdie ROI
• Freshchat: Birdie with Freshchat
• Installation: How to install Birdie on Freshchat
• Flows: Birdie x Freshchat
• Manual Request: Request screen recordings from customers through both the Freshchat sidebar and editor
• Jira Service Management: Birdie with Jira Service Management
• Installation
• Flows: Birdie x Jira
• Human Request: Request screen recordings from customers through Jira agent view
• Customer Portal
• Uninstall: Bye Bye
• Help Scout: Birdie with Help Scout
• Installation: How to install Birdie on Helpscout
• Flows: Birdie x Help Scout
• Human Request: Request screen recordings from customers through both the Help Scout sidebar and editor
• Saved Replies: Add Birdie to your Saved Replies in HelpScout
• Auto Reply: Add Birdie to your Auto Reply in HelpScout
• Salesforce Service Cloud: Birdie with Salesforce Service Cloud
• Installation: Add Birdie to Salesforce Service Cloud
• Flows: Birdie x Salesforce Service Cloud
• Agent-Initiated Requests (Cases)
• Agent-Initiated Requests (Messaging – In-App & Web)
• Ticket Form: Add Birdie to your Salesforce Ticket Form
• Customer Portal
• Analytics: Tracking Recordings & Requests Inside Salesforce
• HubSpot
• Installation: Add Birdie to Hubspot
• Flows: Birdie x HubSpot
• Human Request via sidebar: Request screen recordings from customers via HubSpot sidebar:
• Human Request via snippet
• Forms: How to add Birdie to your HubSpot ticket form
• Auto Reply (Marketing email)
• Analytics: How to Track Birdie ROI in HubSpot with a Property
• Pylon: Birdie X Pylon
• Installation: Birdie x Pylon
• Flows: Birdie X Pylon
• Human-Initiated Requests (via sidebar): Request screen recordings from customers in Pylon sidebar
• Human-Initiated Requests (via Macro): Request screen recordings from customers in Pylon using Macros
• Triggers: Adding Birdie to Your Pylon Triggers
• Plain: Birdie X Plain
• Installation: Birdie x Plain
• Flows
• Human-Initiated Requests (via Snippet): Request screen recordings from customers in Plain using Snippets
• Crisp: Birdie x Crisp
• Flows: Birdie x Crisp
• Human-Initiated Requests: Request screen recordings from customers through the Crisp sidebar
• AI Agent: This will guide you through setting up your Birdie Plugin with Hugo AI Agent
• Workflows: This will guide you through setting up a Request Recording step when building a Workflow
• Front: Birdie x Front
• Flows: Birdie x Front
• Human-Initiated Requests: Request screen recordings from customers through the Front sidebar
• Others
• Happyfox: Birdie with Happyfox
• Installation: How to install Birdie on Happyfox
• Flows: Birdie x Happyfox
• Human Request: Request screen recordings from customers through Happyfox
• Support Center Ticket Form: How to add Birdie to your Happyfox ticket form
• Ada: Add Birdie to your Ada flows
• Forethought: Add Birdie Recording Links to your Forethought flows
• Maven AGI: Add Birdie Recording Links to your Maven AGI flows
• Service Now: Birdie X Service Now CSM
• Flows: Birdie x Service Now CSM
• Zoho Desk: Birdie x Zoho Desk
• Flows: Birdie x Zoho Desk
• Other Helpdesk: Birdie x Other Helpdesk
• Flows
• Human Request: Birdie x Other Helpdesk
• Ticket Form
• Linear Integration: Birdie’s Linear integration lets your team send screen recordings directly to Linear, so bugs and product issues can be reported with all the right context in a few clicks.
• MCP Server: Use the Birdie MCP server to give AI agents access to recordings and debugging data, including transcripts, console logs, network requests, user events, and structured metadata.coming soon....
• Storage Location: Where does Birdie keep the data?
• Storage in your own AWS S3 bucket(s)
• Storage in your own GCP bucket(s)
• Storage in your Azure Container: This guide explains how to create a dedicated Azure Storage Account for Birdie, configure it for secure video delivery, and share the credentials with Birdie.
• Custom Data Retention Policies: Meet your organization’s compliance requirements by automatically deleting recordings on a pre-determined schedule (e.g. 90 days).
• One-time Request links
• Recordings Privacy Settings
• Incoming Recordings: Allow Public Access: Allow access to anyone with the link.
• Outgoing Recordings: Restrict Access to Workspace Members + Selected Externals: Restrict access to workspace members and selected externals
• Hide sensitive data: How to blur sensitive data in your web app automatically
• GDPR opt-in: Comply with your privacy requirements.
• Audit Logs
• Two-factor authentication: How to set up two-factor authentication for your Birdie account.
• Remote log out
• SAML SSO: Access Birdie using your Identity Provider (Okta, Microsoft Azure, Google workspace, etc...)
• Setup SSO with Okta
• SCIM: Automating user provisioning
• Okta settings: Some specifics for setting up SCIM with Okta described in the following recording.

Birdie API

• Overview: Welcome to the Birdie API! You can use this API to access our endpoints, such as the Birdie API to get your recordings.
• Authentication: The Birdie API uses Personal access tokens, called API Key, to authenticate requests.
• Pagination: Some methods return paginated results. The formatting of a paginated result is always:
• HTTP Status & Errors: All responses from the API will include a standard HTTP successful or error status code.
• API Reference: Here you can find a list of the different endpoints available to use across the Screendesk API. Click into each card to learn more.
• Get a Recording: This is the method to request a single recording if you have its identifier or its sharing link code.
• List Recordings: This is the method to get a list a recordings, you can query them with some parameters.
• Webhook Integration Guide: This guide explains how to securely and reliably receive Birdie screen recording webhooks in your backend.

Troubleshooting

• Something not working right?: Quick guides to help you fix specific issues when they pop up
• Zendesk
• How to prevent sending an email notification to the customer after recording: How to prevent sending an email notification to the customer when they make a recording
• Extension
• Error: This page cannot be scripted due to an ExtensionsSettings policy

Agent Instructions: Querying This Documentation

If you need additional information, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on a page URL with the ask query parameter:

GET https://docs.birdie.so/birdie-docs/what-is-birdie.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.