---
schema_version: "1"
id: c842c9922fecae8445422ec1c64d281583c50948cb259a7b25f52346f210f4b6
title: TrailheadSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_trailheadsettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_trailheadsettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: a1d052774fcae1ccf18351a648a0d9a4eeac40fa102f91b4f8da536b4cad5e7b
description: Represents an org’s integration with Trailhead for Learning Paths or Enablement programs, including access to enablement sites (formerly myTrailhead).
---
# TrailheadSettings

Represents an org’s integration with Trailhead for Learning Paths or Enablement programs, including access to enablement sites (formerly myTrailhead).

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

TrailheadSettings values are stored in the Trailhead.settings file in the settings directory. The .settings files are different from other named components because there's only one settings file for each settings component.

## Version

TrailheadSettings components are available in API version 47.0 and later.

## Special Access Rules

To access enablement site (myTrailhead) content, the org must have a Sales Enablement license.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| enableConfettiEffect | boolean | Indicates whether animated confetti plays on the screen after a user reaches certain milestones, such as completing an Enablement program in the Guidance Center. The default value of this field is false. |
| enableMyTrailheadPref | boolean | Indicates whether the org is connected to an enablement site (myTrailhead). The default value of this field is true. |
| enableTrailheadInLexTerms | boolean | Indicates whether the terms and conditions for showing Trailhead content in Lightning Experience are accepted in your org. The default value of this field is false. |

## Declarative Metadata Sample Definition

The following is an example of a TrailheadSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<TrailheadSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableMyTrailheadPref\>true</enableMyTrailheadPref\>
</TrailheadSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>Trailhead</members>
        <name>Settings</name>
    </types>
    <version>47.0</version>
</Package>

## Wildcard Support in the Manifest File

The wildcard character \* (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).