Skip to content
Docs

Keyword

On this page
  1. Settings
  2. When is it healthy?
  3. Examples

The Keyword sensor requests a page and checks that a word or a sentence appears in it — or that it does not. Use it when "the server answers" is not enough: the page should really show your content, not an error page served with a 200 code.

In the wizard: Website → Specific content.

Settings#

The request settings are those of the HTTP sensor (method, URL, timeout, accepted codes, SSL, advanced options), plus:

Setting Description
Keyword The text to look for in the response body.
Up if keyword present On: healthy when the text is found. Off: healthy when it is absent — to detect an error message.
Case sensitive Whether Checkout and checkout are different.

When is it healthy?#

When the request succeeds with an accepted code and the keyword condition holds.

Examples#

  • Storefront — Homepage content: the home page must contain Add to cart.
  • Developer docs — Search: the search page must contain results for.
  • Turn Up if keyword present off to fail when a page shows Maintenance in progress.