How to Integrate Yoast with Your Headless CMS

What is Yoast?

Yoast is an SEO tool best known for its WordPress plugin, with additional products for Shopify and content SEO training. Teams use it to analyze on-page SEO, set titles and meta descriptions, generate schema output, manage canonicals, and produce XML sitemaps. It has a large footprint in WordPress-based publishing, which makes it a common SEO requirement when teams move to API-first, structured content.

Why integrate Yoast with a headless CMS?

The alternative is usually brittle: CSV exports, manual WordPress mirrors, delayed batch jobs, or SEO checks that happen after the page is already live. The trade-off is that Yoast is still most native to WordPress. For a true headless stack, you'll usually choose one of two patterns: mirror publishable content into WordPress with Yoast installed, or use YoastSEO.js inside your editorial workflow for analysis while your frontend renders the final metadata.

Architecture overview

A typical Sanity and Yoast integration starts when an editor publishes a document in Sanity Studio. A Sanity webhook, filtered to `post`, `page`, or `product` publish events, calls a Sanity Function or your own webhook route. That server-side code uses GROQ to fetch only the fields Yoast needs, for example title, slug, body text, focus keyword, meta description, canonical URL, category, and author. The Function then calls the WordPress REST API on a WordPress site where the Yoast SEO plugin is installed, creating or updating the matching post and its Yoast meta fields. After WordPress saves the post, the Function calls Yoast's REST endpoint, `/wp-json/yoast/v1/get_head?url=...`, to read the generated title, meta tags, Open Graph tags, Twitter tags, and JSON-LD schema. Your frontend can render that SEO output directly, cache it, or write selected values back to the Content Lake for preview and audit workflows. The end user never sees the sync step. They just get the published page with the correct metadata in the HTML head.

Common use cases

Step-by-step integration

1. 1

   Set up Yoast where it runs

   Install Yoast SEO on WordPress if you're using the WordPress mirror pattern. Create a WordPress application password for the integration user. Yoast doesn't issue a general API key for arbitrary headless projects, so the common API path is WordPress REST plus Yoast's `/wp-json/yoast/v1/get_head` endpoint.

2. 2

   Expose the Yoast fields you need

   If you plan to write Yoast fields through the WordPress REST API, register fields like `_yoast_wpseo_title`, `_yoast_wpseo_metadesc`, and `_yoast_wpseo_focuskw` with `show_in_rest`, or create a small WordPress endpoint that updates Yoast post meta safely.

3. 3

   Model SEO fields in Sanity Studio

   Add fields such as `seoTitle`, `metaDescription`, `focusKeyword`, `canonicalUrl`, `ogImage`, `schemaType`, and `wpPostId`. Keep them typed and validated. For example, set a 160-character warning on `metaDescription` and require `canonicalUrl` only for syndicated content.

4. 4

   Create the sync trigger

   Create a Sanity webhook for publish events, or use a Sanity Function if you want the sync code to run server-side without setting up a separate worker. Filter the webhook so draft saves don't call Yoast on every keystroke.

5. 5

   Fetch content with GROQ and call Yoast

   Use GROQ to select the exact fields needed for the Yoast payload, including joined references such as author name, category title, and Open Graph image URL. Update the WordPress post, then call Yoast's `get_head` endpoint for the public URL.

6. 6

   Test preview, publish, and frontend rendering

   Test one article, one product page, and one page with a custom canonical. Confirm the frontend renders `<title>`, meta description, canonical, Open Graph tags, and JSON-LD schema from the synced Yoast output or from your Sanity fields.

How Sanity + Yoast works

CMS approaches to Yoast

Keep building

Explore related integrations to complete your content stack.