---
schema_version: "1"
id: 14bc8ec40e7e1f2b05dcc6275955d26f819c146f2761d17eb7bba62723c5d506
title: ChatterExtension
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_chatterextensions.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_chatterextensions.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 9bcd62779e2cf784a28c8805ed7a280d40c67abc2d9223219d07c1a016b2760f
description: Represents the metadata used to describe a Rich Publisher App that’s integrated with the Chatter publisher.
---
# ChatterExtension

Represents the metadata used to describe a Rich Publisher App that’s integrated with the Chatter publisher.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

## Retrieving ChatterExtension

Using an API tool, you can get extension information from package.xml using this code.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
 <types\>
  <members\>xw1</members\>
  <name\>ChatterExtension</name\>
 </types\>
 <version\>41.0</version\>
</Package\>

Use the <members> tag to name a specific extension (in this example, xw1), or use the wildcard (\*) symbol to retrieve all your extensions.

Here’s an example of retrieved information.

<?xml version="1.0" encoding="UTF-8"?>
<ChatterExtension xmlns="http://soap.sforce.com/2006/04/metadata">
  <compositionComponent\>xwComp</compositionComponent\>
  <description\>des</description\>
  <extensionName\>xw1</extensionName\>
  <headerText\>h1</headerText\>
  <hoverText\>h2</hoverText\>
  <icon\>tiger</icon\>
  <masterLabel\>primary</masterLabel\>  
  <renderComponent\>xwRend</renderComponent\>
  <type\>Lightning</type\>
</ChatterExtension\>

## Version

ChatterExtension is a new feature in API version 41.0.

## Fields

| Field | Field Type | Description |
| --- | --- | --- |
| compositionComponent | string | Required. The composition component of the Rich Publisher App that you provide. It’s comprised of the lightning:availableForChatterExtensionComposer interface. |
| description | string | Required. The description of your custom Rich Publisher App. |
| extensionName | string | Required. The name of your extension. That is, your Rich Publisher App. |
| headerText | string | The text to show in the header of your app composer. Header text is required for Lightning type extensions. This text can be localized. |
| hoverText | string | The text to show when a user mouses over your extension’s icon. Mouse-over text is required for Lightning type extensions. This text can be localized. |
| icon | string | Required. The icon to show in the Chatter publisher. Use an existing file asset id from your org. |
| isProtected | boolean | An auto-generated value. It currently has no impact. |
| masterLabel | string | Required. Label for the ChatterExtension object. |
| renderComponent | string | Required. The rendering component of the Rich Publisher App that you provide. It’s comprised of the lightning:availableForChatterExtensionRenderer interface. |
| type | ChatterExtensionType ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string) | Required. Describes the type of the extension. Currently, the only value supported is Lightning. Included to allow for other possible types in the future. |

## Wildcard Support in the Manifest File

This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. 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).

#### See Also

- [Integrate Your Custom Apps into the Chatter Publisher](https://developer.salesforce.com/docs/atlas.en-us.264.0.lightning.meta/lightning/components_integrate_customapps_to_publisher.htm "Integrate Your Custom Apps into the Chatter
    Publisher - HTML (New Window)")