Connect Custom edge

What the snippet does

• People pass straight through. Their requests go to your site untouched. When someone arrives from a link in an AI answer, the page and the assistant are counted, with no IP address, user agent or cookies.
• AI agent visits are reported after the response is on its way: the time, host and path (without the query string), the agent and how your site answered. Cookies and form data are never sent, and only the network prefix of the IP address is stored.
• It fails open. If Contentstack Canoe is slow or down, your site answers as usual.

Before you start

• Owner or admin in Contentstack Canoe to connect.
• Someone who deploys your site's edge or server. The install code never contains the secret, so you can share it.
• A supported platform:

On Cloudflare and rather not deploy code? Connect Cloudflare installs the Worker for you.

Connect

1. Open your brand's settings, select Integrations, then Connect on the Custom edge card.

2. Check the hosts. Add every hostname that serves your site, such as brightkeel.example and www.brightkeel.example. Press Enter after each one, then select Connect.

3. Copy the secret. It's shown once. Store it in your password manager or secrets store, tick I've stored the secret somewhere safe and select Done.

4. Install. Under Install code, pick your platform and follow its numbered steps. Each has its own copy button.

5. Add the secret to your edge or server as CONTENTSTACK_CANOE_SECRET. Never put it in code that runs in the browser.

6. Deploy. The card leaves Waiting for first event when the first visit or check arrives, usually within a minute.

Check the install

The card shows the status, events and dropped events in the last 24 hours, and coverage. Check now sends one test visit to each host through your edge and reports what came back.

To see a visit yourself, request a page with an AI agent's user agent:

curl -A "Mozilla/5.0 (compatible; GPTBot/1.3; +https://openai.com/gptbot)" https://www.brightkeel.example/pricing

It shows in Agent Traffic as Spoofed or Unverified, because it doesn't come from OpenAI's network. That's expected.

Add a host

Your site also answers on another hostname, such as a CDN or proxy address? Select Add a host. Its visits count for your pages once Contentstack Canoe checks that the host reaches this edge and shows the same pages.

Rotate the secret

Select Rotate secret and copy the new secret into your edge. The current one keeps working for 48 hours, so you can update without losing visits. If it leaked, choose to stop accepting the old one right away.

Disconnect

Disconnect stops Contentstack Canoe from accepting visits from this edge. Then remove the snippet from your site. Agent traffic already collected stays in your reports.

Troubleshooting