WebSite Schema Markup
WebSite markup on your homepage describes the site as a whole: its name, alternate names, and URL. Google says it's the most important way to state your preferred site name for search results. It used to enable the sitelinks search box, which Google retired in November 2024.
Google Search Features
- Site name The site name shown with search results. Only read on the home page. The Rich Results Test doesn't check it.
- Sitelinks search box — Retired (since November 21, 2024) Google no longer shows this rich result. WebSite is still a valid schema.org type; the markup does no harm but earns no rich result.
When to Use WebSite
Properties
| Property | Type | Status | Description |
|---|---|---|---|
| name | Text | required | The website name. |
| url | URL | required | The homepage URL. |
| alternateName | Text | optional | Another name for the site, such as an acronym or shorter name. |
| potentialAction | SearchAction | optional | Describes the site search URL pattern. Google used it for the sitelinks search box, which it retired in November 2024. |
| description | Text | optional | Site description. |
JSON-LD Examples
Website with Search
Homepage markup with a site search action.
{
"@context": "https://schema.org",
"@type": "WebSite",
"name": "Example Shop",
"url": "https://example.com",
"potentialAction": {
"@type": "SearchAction",
"target": {
"@type": "EntryPoint",
"urlTemplate": "https://example.com/search?q={search_term_string}"
},
"query-input": "required name=search_term_string"
}
}Common Mistakes
Adding WebSite markup to every page — it should only be on the homepage.
Not matching the potentialAction target URL to your actual search page URL.
Complete Guide to WebSite Schema Markup
WebSite schema markup belongs on your homepage and describes your website as a whole. Google generates site names for search results automatically, but it says WebSite structured data is the most important way to state your preference: put your preferred name in name and a common alternative, such as an acronym, in alternateName.
A potentialAction with a SearchAction describes your site's search URL pattern, with {search_term_string} as the placeholder for the query. It used to enable the sitelinks search box, but Google retired that feature in November 2024. The markup is still valid schema.org.
Related Types
Check Your WebSite Markup
The generator doesn't have a WebSite form yet. Paste your markup into the validator to check its types, properties and values, and what Google needs from it.
Open Validator