There are currently 3 different deployment options for schema markup created using the Highlighter:
This tag is what will fetch and build the associated schema markup for each page. This is typically added via a Tag Manager or in your CMS's theme.
The schema markup is dynamically generated every time a visitor comes to that particular page and therefore the schema markup is always up to date. This is the most common deployment method and requires hardly any technical resources.
How it works:
The highlight.js is used to look up the page's configuration file using the URL of the page. It will inspect the HTML of the page determined by the Configuration file to find content, and then places the content into a JSON structure to represent Schema Class / Properties. Once called, it returns a combined JSON-LD data block into a script tag.
Immediate updates to schema markup
Durable integration method (most commonly used)
This method is typically used for templates which have a low content update frequency. That is because the Schema Markup is only crawled and generated on a weekly cadence (or on any create/edit events).
Place the following code on every templated page of your site:
How it works:
Schema App's crawler (schema bot) will crawl the site page by page until it finds a page that matches the template's page set. Once found it will check whether its json-ld exists or matches a current version stored and if needed send out an update.
Note some sites that block crawlers may need to whitelist our bot, its useragent is
Mozilla/5.0 (compatible; SchemaBot/1.2; +https://www.schemaapp.com/bot/)
It will crawl from the following IP address: 22.214.171.124
Fastest HTML rendering
Schema App pre-generates data with a crawler
Supported by Schema App CMS integrations
Requires backend integration (unless using Schema App CMS integration)
Less frequently updated schema markup
JavaScipt + Webhooks
You must first add an endpoint that supports Schema App's webhooks. (If using WordPress this will be done for you). Next, Make sure the following tag is included on every templated page.
*Replacing <YOUR_API_KEY> with your API key found here.
- Nearly up to date schema markup (Realtime - 1 page load)
- Supported by Schema App CMS integrations
- Supports AMP
- Requires Schema App CMS integration, e.g. Wordpress, Drupal, or custom backend webhook handler.
- Can be out of date with live content (only as recent as the last page load)