Skip to content
HonkWatch
PricingLocationsHonk RadarHelpAPI Log inGet started
All help topics

Getting started

  • Getting started
  • How checks work

Monitors

  • Which monitor to use
  • Website monitor
  • API monitor
  • Keyword monitor
  • Ping monitor
  • Port monitors (TCP and UDP)
  • DNS monitor
  • SSL certificate monitor
  • Domain expiry monitor
  • Third-party services
  • Page load monitor
  • Heartbeat monitor (cron jobs)
  • Maintenance windows
  • Incidents

Alerts

  • Setting up alerts
  • Email alerts
  • Slack
  • Microsoft Teams
  • Discord
  • Telegram
  • PagerDuty
  • ntfy
  • Webhooks
  • Zapier

Phone and desktop app

  • The phone and desktop app
  • App alerts not arriving

Status pages

  • Status pages
  • Status page on your own domain

Team and account

  • Team members
  • Plans and limits
  • API keys and the API
  • Your account

Troubleshooting

  • A monitor says down but my site works
  • I did not get an alert
  • Allowing our checks through a firewall
  • Questions and answers

Help / Monitors

Keyword monitor

A keyword monitor loads a page and looks for a word or phrase in it. You choose whether the monitor goes down when the text is missing, or when it appears. Use it when a page can fail while still answering normally, for example a shop that shows an error message with a "200 OK" status.

What you need first

  • The full address of the page. It must be reachable from the public internet.
  • A piece of text to look for, up to 200 characters. Pick something that is only on the page when it works, such as a product name or "Add to cart". Or pick text that only shows when something is wrong, such as "Out of stock" or "Database error".

Set it up

  1. Open Monitors and press Add monitor.
  2. Pick Keyword on page.
  3. Type the page address into URL.
  4. Under Keyword, type your text into Keyword to look for.
  5. Choose when the monitor should go down:
    • Start incident when keyword doesn't exist (the default): down when the text is missing.
    • Start incident when keyword exists: down when the text appears.
  6. Tick Case-sensitive check only if capitals matter. When it is off, "Sold Out" also matches "sold out".
  7. Give it a Friendly name, choose Check every and press Start monitoring.

How the search works

  • We search the page's HTML source, not the page as it looks in a browser. HTML markup works in the keyword, for example <span id="stock">Out of stock</span>. The markup must match the source exactly, spaces and quotes included.
  • Text that the page adds with JavaScript after it loads is not in the source, so we cannot see it. To check, open the page in your browser, choose View page source, and search for your text there.
  • We read the first 512 KB of the page. Text further down a very large page is not searched.
  • The status code is checked first. If it is not a good status code (200-399 unless you change it under More settings), the monitor fails with that code before the keyword is looked at.
  • Leave Method under More settings on GET. A HEAD request gets no page back, so there is nothing to search.

All the other settings, such as timeout, redirects, headers and how many cities must agree, work as they do for a Website monitor.

Test it

  1. After saving, you land on the monitor's page. Once the first checks are in, it says "Working".
  2. If you want to see a real alert, press Edit, change the keyword to text that is not on the page, and press Save changes. With the default settings the monitor goes down once two cities have each failed twice in a row, and you get a down alert. This can take a few minutes.
  3. Change the keyword back and save. You get a "back online" alert when it recovers.

This test opens a real incident. If the monitor is on a status page, the page shows it as down and subscribers who follow it get an email. Do it on a monitor that is not on a status page. To only check that alerts arrive, use Send test on the Alerts page instead.

When it does not work

  • "Keyword missing" but you can see the text. It is probably added by JavaScript, written differently in the source (for example &amp; instead of &), or split by markup. Search the page source and copy the text from there. Also check whether Case-sensitive check is ticked.
  • "Keyword missing" from some cities only. The site may show a different page by country or language, or show a cookie or bot check page to some visitors. Pick text that is on every version, or choose cities under Check from.
  • "Keyword found" when you expected it to be gone. The text may also be somewhere else in the source, such as a hidden menu or a script. Make the keyword longer so it only matches the place you mean.
  • "HTTP" and a number. The page answered with a status code outside your good status codes. See Website monitor.
  • Down, but the page works for you. See A monitor says down but my site works.
← API monitor Ping monitor →

Still stuck? Email [email protected] and say which guide you were following.