Lightning Aura Components Developer Guide

Introducing Aura Components
Quick Start
Creating Components
Using Components
Communicating with Events
Communicating Across the DOM with Lightning Message Service
Create a Message Channel
Publish on a Message Channel
Subscribe to a Message Channel
Lightning Message Service Limitations
Creating Apps
Styling Apps
Developing Secure Code
Using JavaScript
Working with Salesforce Data
Testing Components
Debugging
Performance
Reference
PDF

Create a Message Channel

To create a lightning:messageChannel component in your org, use the LightningMessageChannel metadata type and append it with __c. The message channel isn’t a custom object, it just uses the same suffix.

See LightningMessageChannel in the Metadata API Developer Guide.

Note

To deploy a LightningMessageChannel into your org, create a Salesforce DX project. Include the XML definition in the force-app/main/default/messageChannels/ directory. The LightningMessageChannel file name follows the format messageChannelName.messageChannel-meta.xml. To deploy it to your scratch org, sandbox, or Developer Edition org, run the sf project deploy start Salesforce CLI command.