Configuration

Ketch Smart Tag Full Configuration

The Ketch Smart Tag configuration JSON object contains all the necessary information to configure the Ketch Smart Tag and the experiences that will be presented to the user. Note the configuration should always be loaded from the Ketch CDN and never embedded within your website bundle or code.

{
  "canonicalPurposes": {
        "essential_services": {
            "code": "essential_services",
            "name": "essential_services",
            "purposeCodes": [
                "essential_services"
            ]
        },
      ...
  },
  "dataSubjectTypes": [
      {
          "code": "customer",
          "name": "Customer"
      }
  ],
  "deployment": {
      "code": "default_deployment_plan",
      "version": 1678296457
  },
  "environment" : {
      "code": "production",
      "hash": "8013869916755790322",
      "pattern": "Lio="
  },
  "environments": [
     {
          "code": "production",
          "hash": "8013869916755790322",
          "pattern": "Lio="
      }
  ],
  "experiences": 
        "preference": {
            "code": "default_preference_management",
            "consents": {
                "bodyDescription": "We collect and use data--including, where applicable, your personal data--for the purposes listed below. Please indicate whether or not that's ok with you by toggling the switches below.",
                "bodyTitle": "Choose how we use your data",
                "buttonText": "Submit",
                "tabName": "Preferences"
            },
            "overview": {
                "bodyDescription": "Welcome! We're glad you're here and want you to know that we respect your privacy and your right to control how we collect, use, and store your personal data.",
                "tabName": "Overview"
            },
            "rights": {
                "bodyDescription": "Applicable privacy laws give you certain rights with respect to our collection, use, and storage of your personal data, and we welcome your exercise of those rights. Please complete the form below so that we can validate and fulfill your request.",
                "bodyTitle": "Exercise your rights",
                "buttonText": "Submit",
                "tabName": "Your Rights"
            },
            "title": "Your Privacy",
            "version": 1678141481
        },
  "identities": {
      "swb_website_smart_tag": {
          "type": "managedCookie",
          "variable": "_swb"
      }
  },
  "jurisdiction": {
      "code": "default",
      "defaultJurisdictionCode": "default"
  },
  "language": "en",
  "organization": {
        "code": "<ORGANIZATION_CODE>"
  },
  "plugins": {
        "lanyard": {}
  },
  "privacyPolicy": { },
  "property": {
      "code": "website_smart_tag",
      "name": "Website Smart Tag",
      "platform": "WEB"
  },
  "purposes": [
        {
            "canonicalPurposeCode": "essential_services",
            "code": "essential_services",
            "dataSubjectTypeCodes": [
                "customer"
            ],
            "description": "Collection and processing of personal data to enable functionality that is essential to providing our services, including security activities, debugging, authentication, and fraud prevention, as well as contacting you with information related to products/services you have used or purchased; we may set essential cookies or other trackers for these purposes.",
            "legalBasisCode": "disclosure",
            "legalBasisDescription": "Data subject has been provided with adequate disclosure regarding the processing",
            "legalBasisName": "Disclosure",
            "name": "Essential Services",
            "requiresDisplay": true,
            "requiresPrivacyPolicy": true
        },
        ...
  ],
  "regulations": [
      "default"
  ],
  "services": {
      "lanyard": "https://global.ketchcdn.com/transom/route/switchbit/lanyard/shopify_test/lanyard.js",
      "scriptHost": "https://cdn.ketchjs.com",
      "shoreline": "https://global.ketchcdn.com/web/v2/"
  },
  "termsOfService":{ },
  "theme": {
        "bannerBackgroundColor": "#01090E",
        "bannerButtonColor": "#ffffff",
        "bannerContentColor": "#ffffff",
        "bannerPosition": 1,
        "buttonBorderRadius": 5,
        "code": "default",
        "description": "Ketch default theme",
        "formButtonColor": "#071a24",
        "formContentColor": "#071a24",
        "formHeaderBackgroundColor": "#071a24",
        "modalButtonColor": "#071a24",
        "modalContentColor": "#071a24",
        "modalHeaderBackgroundColor": "#f6f6f6",
        "modalPosition": 1,
        "name": "Default"
    }
}