Get Started with Custom Lightning Types
These resources are available to help you customize your agent’s interface.
| I want to... | Recommended Content |
|---|---|
| Build using the Setup UI Create and configure custom Lightning types directly in Setup. | Create a Custom Lightning Type |
| Understand the architecture Learn the core concepts, file structure, and how schema projection works. | Core Concepts of Custom Lightning Types |
| Choose my approach Decide whether to use an Apex class or define a manual JSON schema. | Categories of Custom Lightning Types |
| Start building Create the definition by structuring the LightningTypeBundle metadata. | Get Started with Lightning Types |
| Build with AI Use the Lightning Types MCP tool to generate schemas and UI configurations using natural language prompts. | Custom Lightning Type Creation with Lightning Types MCP Tool |
| Customize the UI Build editor.json and renderer.json files to override the default interface with your own Lightning web components. | UI Configuration for Apex-Based Custom Lightning Types |
| Deploy and manage Deploy your custom Lightning types and Lightning web components using Metadata API or Salesforce CLI. | LightningTypeBundle Metadata Type |
| Integrate and test Assign your custom Lightning type to an agent action, and verify the behavior in Agentforce Builder. | Integrate a Custom Lightning Type with an Agent Action |
Use these resources to automate, deploy, and reference custom Lightning types.
Metadata API and Deployment
Use the LightningTypeBundle metadata type to define and deploy your custom Lightning types. Understand the required file structure, supported fields, and how to structure your package.xml manifest for deployment.
- Metadata API Developer Guide: LightningTypeBundles
Standard Lightning Type References
Review the keywords and default behaviors for the Salesforce types.
- Lightning Types Developer Guide: Standard Lightning Types
Connect API
Retrieve information about the types available in your org by using Connect REST API.
- Connect REST API Developer Guide: Type System Resources
Lightning Types MCP Tool (Developer Preview)
Accelerate development by using Agentforce Vibes to generate LightningTypeBundle metadata files through natural language prompts.
- Lightning Types Developer Guide: Custom Lightning Type Creation with Lightning Types MCP Tool
See Also