Sharing Content as Links

A share link is a tokenized URL that, when opened on your application's own domain, makes the BreakGround SDK render a specific published content item immediately. Use it to send a flow, tooltip, survey, announcement, task list, journey, self-help widget, beacon, or NPS prompt to a single user — typically from a support reply, a customer success follow-up, or a lifecycle email — without changing your installation or targeting rules.

Share links bypass the audience and frequency settings the content normally evaluates, because the recipient has been directed to the content intentionally. They do not bypass authentication: the link opens your real product, in the recipient's normal authenticated session.

When to Use a Share Link

• A support agent has identified the exact walkthrough that answers a customer's ticket and wants the customer to see it run live on their account.
• A customer success manager wants to nudge a single account toward a feature they have under-adopted, and wants the link to deliver the in-app walkthrough rather than a help article.
• A lifecycle email wants to deep-link from a CTA directly into a product walkthrough running on the recipient's account.
• A product marketer wants a single URL that triggers a release announcement in the app for anyone who clicks it from a launch email or social post.

If the goal is to surface a piece of content to many users based on rules (URL, attribute, behaviour), use the content's targeting rules instead — share links are designed for one-off, human-initiated delivery.

Supported Content Types

Share links are supported for every published content type:

• Flows
• Tooltips
• Beacons
• Announcements
• Surveys
• Task Lists
• Self-help widgets
• NPS prompts
• Journeys

The content must be in PUBLISHED status. Draft, scheduled, and archived content cannot be shared — the dashboard disables the Share action until the content is live.

Creating a Share Link

From the Dashboard

1. Open the content item in its builder (Flows, Surveys, Announcements, etc.).
2. Confirm the item is in PUBLISHED status.
3. Click Share in the builder toolbar. The Share Link dialog opens.
4. Confirm or edit the landing URL — this is the page on your domain that the link will open. The dashboard defaults this to your installation's primary origin; change it if the content is meant to render on a specific page or path.
5. Click Create link. A short URL of the form https://<your-app>/s/<token> is generated and copied to your clipboard.

Each content item can have at most one active share link at a time. If a link already exists, the dialog shows the existing link plus a Revoke action; revoke it before creating a replacement.

From the Chrome Extension

The BreakGround Chrome Extension generates share links without leaving the page. While viewing a published content item in the extension panel, click Share to generate or revoke a link. This is the recommended path for support agents who are already on the customer's URL — no context switch back to the dashboard.

Required Role

Members with the OWNER, ADMIN, or EDITOR role can create and revoke share links. Members with the VIEWER role can see existing share links and their analytics but cannot create or revoke.

How the Link Behaves

When a recipient opens the share URL:

1. The short URL (/s/:token) issues a 302 redirect to the configured landing URL with the token appended both as a query parameter (?_wfx_share=<token>) and as a hash fragment (#_wfx_share=<token>). The hash fragment survives any further HTTP redirects your application may perform.
2. The BreakGround SDK detects the token on first paint and calls the share-resolution endpoint to fetch the associated content.
3. The SDK renders the content immediately, bypassing the content's normal audience and frequency rules.
4. Analytics events fired by the content are stamped with the share link's ID, so engagement attributable to the link can be filtered in analytics.

View Tracking

Every share link records:

• View count — total times the link has been opened and resolved by the SDK.
• Last viewed at — timestamp of the most recent open.
• Created by — the dashboard user who generated the link.
• Created at — timestamp of link creation.

These fields appear next to each link in the dashboard. Use them to identify high-traffic links (good candidates to promote into permanent targeted content) and to audit who shared what.

Revocation

Click Revoke in the Share Link dialog (dashboard or chrome extension) to kill the link. After revocation:

• The next time anyone opens the link, the share-resolution endpoint returns 410 Gone and the SDK shows no content.
• The link's analytics (view count, last-viewed timestamp) remain visible in the dashboard for audit purposes.
• A new share link can be created for the same content immediately.

There is no auto-expiry — links live until you revoke them. For one-off ticket replies, build a habit of revoking when the ticket closes.

Security Model

• Token possession grants access to the shared content only. The token does not authenticate the user against your application — they still need to log in normally if your product requires it.
• Tokens are scoped to the company that created them. A token generated in your staging company will not resolve in production, and vice versa.
• Treat share URLs like sensitive links. They are safe to email to a known customer but should not be posted publicly if the underlying content includes account- or customer-specific information.

Limitations

• One active link per content item. Revoke before re-issuing.
• Content must be published. Drafts, scheduled, and archived content cannot be shared.
• Links do not auto-expire. Manual revocation is the only termination mechanism in the current version.
• Share links do not bundle multiple content items into a single URL — each link references exactly one content item.

Troubleshooting

Symptom	Likely cause	Fix
Recipient opens the link and sees no content	Content was unpublished or archived after the link was created	Republish the content; the link will start resolving again.
Link returns 410 Gone	The link has been revoked	Create a new share link from the content's builder.
Recipient lands on the page but the SDK is silent	The SDK script is not installed on the landing URL	Confirm BreakGround is initialised on the page the link opens.
Link tested in staging works, production version 410s	Token was generated in a different company / environment	Generate the link from the company that matches the recipient's environment.