Deployment

Privacy Center Direct Access Links

Configuring Direct Access Links to Your Privacy Center.

Overview

Privacy Center allows you to use direct access links when you want to directly load a specific area of Privacy Center. As an example, your organization may want to add a direct access link in your privacy policy or via email that allows people to go directly to the Privacy Options section to submit a privacy request to view, delete, or change their data. This document will help you add the URL query parameters that will load Privacy Center and show a specific area of Privacy Center including:

  • Details
  • Privacy Options
  • Do Not Sell
  • Consent

Currently you can include the following direct access links on your website, in email communications, etc.:

Details

Privacy Options (Requires Privacy Requests Enabled to be enabled in the Admin UI in Privacy Requests → Request Settings)

Do Not Sell (Requires Privacy Requests Enabled & Enable Do Not Sell to be enabled in the Admin UI in Privacy Requests → Request Settings)

Consent (Requires Consent Mode to be set to anything other than disabled in the Admin UI in Consent → Consent Settings)


Programmatic Widget Control

If loading speed is of the utmost importance, or you need to open a specific section from a button or link, you can use the widget's JavaScript API to control the Privacy Center programmatically. This approach is slightly faster than using direct access links because it doesn't require a page navigation.

When to Use Each Approach

  1. Direct Access Links - The recommended approach for most use cases. Link to your privacy policy page with the query parameter, providing a graceful fallback if the widget fails to load.

  2. Programmatic API - Use window.concord.plugin.widget methods for optimal load performance. Ideal for footer links, navigation elements, or any interactive component where you want instant access to the Privacy Center.

API Methods

All methods are available on window.concord.plugin.widget.

toggle(options?)

Toggles the Privacy Center open or closed. If the widget is currently closed, it opens (optionally to a specific section). If it is already open, it closes, regardless of which section is specified.

// Open or close the Privacy Center
window.concord.plugin.widget.toggle();

// Open to a specific section, or close if already open
window.concord.plugin.widget.toggle({ section: 'consent' });
window.concord.plugin.widget.toggle({ section: 'details' });
window.concord.plugin.widget.toggle({ section: 'privacy_options' });
window.concord.plugin.widget.toggle({ section: 'privacy_options_dns' });

openSection(section)

Always opens the Privacy Center to a specific section. Unlike toggle(), this never closes the widget.

window.concord.plugin.widget.openSection('consent');
window.concord.plugin.widget.openSection('details');
window.concord.plugin.widget.openSection('privacy_options');
window.concord.plugin.widget.openSection('privacy_options_dns');

setOpen(open, options?)

Explicitly sets the open state of the Privacy Center.

// Open the Privacy Center
window.concord.plugin.widget.setOpen(true);

// Open to a specific section
window.concord.plugin.widget.setOpen(true, { section: 'consent' });
window.concord.plugin.widget.setOpen(true, { section: 'privacy_options_dns' });

// Close the Privacy Center
window.concord.plugin.widget.setOpen(false);

Implementation Example

Here's how we implement this on our own site in the footer and nav bar:

<a
  href="/privacy-policy?cord_section=details"
  onClick={(e: React.MouseEvent) => {
    if (window.concord?.plugin?.widget?.toggle) {
      e.preventDefault();
      window.concord.plugin.widget.toggle();
    }
  }}
>
  Privacy Settings
</a>

To open directly to a specific section, for example, a "Do Not Sell" footer link:

<a
  href="/?cord_section=privacy_options_dns"
  onClick={(e: React.MouseEvent) => {
    if (window.concord?.plugin?.widget?.toggle) {
      e.preventDefault();
      window.concord.plugin.widget.toggle({ section: 'privacy_options_dns' });
    }
  }}
>
  Do Not Sell My Data
</a>

These examples check if the Concord widget is loaded and available before calling the API. If the widget isn't available, the link falls back to the direct access URL, ensuring users can always access the Privacy Center.

Section Reference

The valid section values are the same for both URL parameters and the programmatic API:

SectionDescriptionRequirement
detailsOpens the Privacy Center to the Details viewNone
consentOpens to the Consent viewConsent Mode must be enabled
privacy_optionsOpens to the Privacy Options selectorPrivacy Requests must be enabled
privacy_options_dnsOpens directly to the Do Not Sell formPrivacy Requests and Do Not Sell must be enabled

Deprecated Section Values

The following section values still work but will log a deprecation warning to the browser console. Update any existing links or code to use the new values above.

DeprecatedReplacement
privacy_centerdetails
consent_settingsconsent