# WebLink Metadata Type for Custom Buttons and Links > WebLink represents a custom button or link on a standard or custom object (objects//webLinks/.webLink-meta.xml), supporting detail page buttons, detail links, and list view mass-selection buttons. - Source: https://sfdxtalk.com/docs/metadata/web-link-metadata-type/ - Category: Metadata - Applies to: Salesforce Winter '27 (API version 68.0) - Level: intermediate - Published: 2026-11-12 - Last updated: 2026-11-12 - Publisher: SFDX Talk Editorial (unofficial; not affiliated with or endorsed by Salesforce) - License: CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/) ## Why the `WebLink` Metadata Type Still Matters While [QuickAction](/docs/metadata/quick-action-metadata-type/) handles modal LWC and Screen Flow actions on record pages, **`WebLink`** (`objects//webLinks/.webLink-meta.xml`) remains essential for three high-value patterns in Lightning Experience: 1. **List View & Related List Mass Action Buttons (`massActionButton`):** Launching an Autolaunched/Screen Flow URL (`/flow/Mass_Approve_Orders?retURL=...`) or a Visualforce `StandardSetController` page with selected checkboxes (`requireRowSelection = true`). 2. **Native Record Creation with Default Field Values (`/lightning/o/Order/new?defaultFieldValues=...`):** Opening the standard Lightning record creation modal pre-populated with parent field values without writing custom code. 3. **External Deep Links (`link` / `button`):** Launching external ERP, shipping tracker, or DocuSign endpoints with merge fields (`{!Account.ERP_Customer_ID__c}`). ```mermaid flowchart LR WL["WebLink
(objects/Order/webLinks/Create_Return_Order.webLink-meta.xml)"] --> DT1["displayType: button
(Record Highlight Panel / Page Layout)"] WL --> DT2["displayType: massActionButton
(List View & Related List Header)"] WL --> DT3["displayType: link
(Custom Links Section on Detail Layout)"] ``` --- ## Key Metadata Fields on `WebLink` | Field | Type | Required | Description | |---|---|---|---| | `displayType` | `WebLinkDisplayType` | Yes | `button` (Detail Page Button), `link` (Detail Page Link), or `massActionButton` (List View Button). | | `linkType` | `WebLinkType` | Yes | `url` (URL redirect), `page` (Visualforce `ApexPage`), `sControl` (legacy), or `javascript` (Classic only). | | `openType` | `WebLinkWindowType` | Yes | `newWindow`, `sidebar`, `noSidebar`, `replace`, or `onClickJavaScript`. | | `availability` | `WebLinkAvailability` | Yes | `online` or `offline`. | | `encodingKey` | `Encoding` | Yes | Character encoding for URL parameters (typically `UTF-8`). | | `url` | `string` | Conditional | The target URL or merge-field expression when `linkType` is `url`. | | `page` | `string` | Conditional | Developer name of the [ApexPage](/docs/metadata/apex-page-metadata-type/) when `linkType` is `page`. | | `requireRowSelection` | `boolean` | No | Only valid when `displayType` is `massActionButton`. Displays checkboxes on the List View or Related List so users can pass selected `ids` to the target page or flow. | | ` masterLabel` | `string` | Yes | Button or link text displayed to users. | --- ## Real-World XML Example: Lightning Pre-Populated Record Creation Button File: `force-app/main/default/objects/Opportunity/webLinks/New_Renewal_Quote.webLink-meta.xml` ```xml New_Renewal_Quote online Opens standard Quote creation modal with pre-populated Opportunity and Account fields. button UTF-8 url New Renewal Quote replace false /lightning/o/Quote/new?defaultFieldValues=OpportunityId={!Opportunity.Id},Name={!URLENCODE(Opportunity.Name + ' - Renewal')},ExpirationDate={!TEXT(TODAY() + 30)} ``` --- ## Querying `WebLink` via SOQL & Tooling API You can query `WebLink` in standard SOQL to audit legacy `javascript` buttons or hardcoded sandbox URLs across your org. ### 1. Audit Legacy OnClick JavaScript Buttons Blocking Lightning Migration ```sql SELECT Id, PageOrSobjectType, Name, MasterLabel, DisplayType, LinkType, OpenType FROM WebLink WHERE NamespacePrefix = null AND (LinkType = 'javascript' OR OpenType = 'onClickJavaScript') ORDER BY PageOrSobjectType, Name ``` ### 2. Find WebLinks Containing Hardcoded Domains or URLs ```sql SELECT Id, PageOrSobjectType, Name, MasterLabel, DisplayType, Url FROM WebLink WHERE NamespacePrefix = null AND LinkType = 'url' ORDER BY PageOrSobjectType, Name ``` --- ## Senior Architect Best Practices - **Deploying a `WebLink` Does Not Automatically Show It on the UI:** Creating the `.webLink-meta.xml` file only registers the button on the object. To make it visible, you must also add it to the [Layout](/docs/metadata/layout-metadata-type/) (`customButtons`), the [FlexiPage](/docs/metadata/flexipage-metadata-type/) Dynamic Actions bar, or the object's Search Layout / List View button configuration (`searchLayouts.listViewButtons`). - **Always Use `URLENCODE()` inside Merge Expressions:** If an Account or Opportunity name contains an ampersand (`AT&T`), an unencoded merge field inside `defaultFieldValues` will truncate the query string parameter. ## Frequently Asked Questions ### When should you use a WebLink instead of a QuickAction in Lightning Experience? Use a QuickAction for modal LWC or Screen Flow actions on a single record. Use a WebLink when you need a List View mass action button that accepts multiple selected checkboxes, a direct URL redirect with default field values, or a custom detail link inside a field section. ### What are the three displayType values supported by WebLink? The displayType field supports link (a hyperlink placed inside a detail page layout section), button (a detail page button placed in the action bar), and massActionButton (a button placed on List Views and Related Lists). ### Why do JavaScript WebLink buttons (linkType javascript) not appear in Lightning Experience? OnClick JavaScript buttons (openType onClickJavaScript and linkType javascript) are blocked in Lightning Experience for security compliance under Lightning Locker and LWS. Convert them to Lightning QuickActions, Screen Flows, or URL-addressable LWCs. ### Can you query WebLink definitions using SOQL? Yes. Both standard SOQL and the Tooling API allow querying the WebLink object to inspect Name, MasterLabel, PageOrSobjectType, DisplayType, LinkType, OpenType, and Url. ## Official References - https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_weblink.htm