Send Chatter Extension Payload

lightning:sendChatterExtensionPayload

For Chatter Rich Publisher Apps only. Sends the payload and metadata that needs to be saved for the extension with the feed item.

For Use In

Experience Builder Sites

lightning:sendChatterExtensionPayload is a component event that sends your custom component's payload into a Chatter feed. You must use this event with the lightning:availableForChatterExtensionComposer and lightning:availableForChatterExtensionRenderer interface to make your component available to the Chatter publisher.

Rich Publisher Apps are available to Experience Builder sites in topics, group, and profile feeds and in direct messages.

For example, you can create a custom component that generates a random quote in the Chatter feed.

In your client-side controller, fire the lightning:sendChatterExtensionPayload event with your payload.

Next, create a custom component that implements the lightning:availableForChatterExtensionRenderer interface to determine how the quote is displayed in the Chatter feed.

Finally, create a ChatterExtension object in your org and make the components available in the Chatter Publisher via the Administration page in Experience Workspaces.

For more information, see the Lightning Aura Components Developer Guide.

NameDescriptionTypeDefaultRequired
extensionDescriptionThe description for the extension to be saved with the feed item.stringYes
extensionThumbnailUrlThe thumbnail URL for the extension to be saved with the feed item.string
extensionTitleThe title for the extension to be saved with the feed item.stringYes
payloadThe payload data to be saved with the feed item.objectYes