Custom data

Attach your own data - account id, plan, feature flags - to every recording, so whoever opens one already has the context.

Custom metadata requires the Birdie Snippet to be installed on your product pages.

Add it when Birdie starts

If you use the @birdie-so/snippet package, pass a metadata object to initBirdie():

import { initBirdie } from "@birdie-so/snippet";

initBirdie({
  clientId: "YOUR_CLIENT_ID",
  contact: {
    email: "[e-mail]"
  },
  metadata: {
    account_id: "acct_8123",
    plan: "business",
    workspace: "Empire HQ",
    flags: ["new-editor", "beta-search"]
  }
});

Installed Birdie with the plain script tag instead? Add metadata to window.birdieSettings, before the loader runs:

<script>
window.birdieSettings = {
  app_id: "YOUR_APP_ID",
  contact_name: "Alexander the Great",
  contact_email: "[e-mail]",
  metadata: {
    account_id: "acct_8123",
    plan: "business"
  }
};
</script>

Update it while your app runs

Most of what is worth attaching is only known after login, or changes as someone moves around your product. Update it whenever it changes:

import { getBirdieInstance } from "@birdie-so/snippet";

getBirdieInstance((birdie) => {
  birdie.update({
    metadata: {
      account_id: "acct_8123",
      plan: "business",
      current_screen: "billing/invoices"
    }
  });
});

A recording carries the values Birdie holds at the moment it is sent, so the last update before someone hits record is the one that arrives.

What you can send

Anything that survives JSON.stringify: strings, numbers, booleans, arrays, and nested objects. There is no fixed list of keys - use the names your own team already uses, so a recording reads the way your logs and dashboards do.

Keep it to what helps someone understand the recording. A handful of identifiers and a few pieces of state beat a dump of your whole store, which is slower to send and harder to read.

Metadata is visible to anyone who can open the recording, including people outside your workspace if the recording is shared with Anyone with the link. Do not put passwords, tokens, or personal data in it.

Where it shows up

Open the recording and expand Metadata in the side panel. Your object appears there as formatted JSON, with a button to copy the whole thing.

Metadata is also searchable: type a value - an account id, a plan name - into the search box on your recordings list, and the recordings carrying it come back.