👾Snippet

How to install Birdie snippet

Birdie Snippet is required for capturing logs.

Birdie Snippet is required for the CoBrowsing solution.

Birdie Snippet is required if you want to hide sensitive data.

1. Install Birdie snippet

We do not recommend installing Birdie through Google Tag Manager or Segment. The preferred method is to paste the code directly onto your web application, as this will result in faster load times.

1. Go to settings -> general

2. Copy the snippet code and paste it before the </body> tag of your web app. Note that the snippet is unique to your organization.

2. Identify your customers

Screen Recording solution: you can skip this step Co-browsing solution : For a smooth experience, it's crucial to identify your authenticated users.

Make sure to input your own values for these three parameters:

window.birdieSettings = {
		contact_name: "Alexander the Great",
		contact_email: "[e-mail]",
		contact_id: "ebf45a994-32d28c4",
};

Ideally, it should contain the following fields:

Field name	Type	Description
contact_name	string	Name of the user.
contact_email	string	Email of the user.
contact_id	string	Anything unique in your organisation that will help you pinpoint your user.

3. Whitelist Birdie in your Content Security Policy

If you have strict content security policies in place, you may need to add the following policy directives to run the Birdie snippet:

https://*.birdie.so 
wss://sock.birdie.so

Do you have a strict CORS policy?

Cross-origin resource sharing (CORS) is a widely accepted protocol that enables JavaScript XMLHttpRequest (XHR) calls made within a web page to interact with resources from different domains.

Birdie requires download access to your stylesheets, images, and other assets necessary for rendering the page. If you have implemented a strict CORS policy, kindly adjust it to allow the necessary access.

Co-browsing: Network configuration requirement

A website that integrates Birdie co-browsing should ensure that its assets such as images, stylesheets, CSS, icons, and fonts are publicly accessible on the internet. This allows the agent view to reuse them and correctly render the page. In addition, VPNs, firewalls, or other corporate networks must whitelist the Secure Websocket protocol (wss) wss://.birdie.so and https://.birdie.so for port 443 via TCP and UDP.

Send instructions to your developers

If you don't have access to your codebase and need help with the installation, you can send the instructions to your developers directly for your settings page.

If you need help or have a question, contact us at [e-mail]