Skip to main content
Support

Adding URL Redirects

Over time, it's normal for links to change. But sending a customer to a 404 error page isn't the best experience (although ours are pretty cool!). With HelpDocs, you can redirect your customers to a new URL so they find what they're looking for right away.

Taylor
Updated by Taylor
4 min read

Broken links are frustrating: nobody enjoys hitting a 404 error page when looking for information.

While our Smart 404 pages do a great job of guiding lost visitors, wouldn't it be better if your customers never encountered them at all?

With URL redirects in HelpDocs, you can seamlessly guide your visitors from outdated links to the correct destinations. This keeps your Knowledge Base navigation smooth and ensures customers find exactly what they need without frustration.

For security, redirects won't work on expired trials, delinquent or cancelled accounts, or trials pending review.

Setting Up a URL Redirect

The Your redirects list with From, To, and Type columns showing three example redirects, and an Add redirect button
  1. Head to Settings > Redirects (or click here)
  2. Hit Add redirect
    1. In From, enter your broken link
    2. In To, enter the new link
      Make sure to include /article or /category at the start if you're redirecting from an article or category 🐝
    3. Under Type, stick with 301 permanent, or choose 302 temporary if the old link might come back
  3. Click away from the row. Each redirect saves as soon as you finish it, so there's no save button to hit

To delete a redirect, open the menu at the end of its row and choose Remove, then Confirm Remove.

Sending Every Broken Link to One Page
We think our 404 pages are pretty neat but you can send any link that doesn't exist to a page of your choice. Add a redirect with /* in From, point To at a page that exists, and keep it last in your list. Visitors get a redirect rather than a 404 error code.
Smart Redirects
We only apply redirects if we can't find content for the URL in From. If you want to redirect from an article or category that exists and is published, you'd need to unpublish or delete it first.

Advanced Pattern Matching

Use * in From to match anything, including further slashes. That means you can do stuff like /my-redirect/* to redirect anything with /my-redirect/ at the start.

* is the only wildcard. Every other character has to match exactly, so patterns like !/my-path or /{old,older}-page won't do anything.

We check each link with and without its query string, so /old-page also catches /old-page?ref=email.

Putting Redirects in Order

The first redirect that matches is the one that fires, so a broad wildcard can get in the way of a more specific redirect below it.

Drag a redirect by its handle to reorder your list, or open the menu at the end of its row and choose Move to top. Dragging isn't available while you're searching or when you have more than 50 redirects, but Move to top always is.

Common Pitfalls and Troubleshooting

Even with a straightforward process, redirects can sometimes be tricky. Here's a quick reference for common issues and their solutions:

Issue

Solution

Redirect not working

Verify you've included the full path in both URLs (e.g., /article/your-slug)

Redirecting a published article

Unpublish or delete the article first, since smart redirects only work when the original content doesn't exist/isn't published

Redirect loop

We refuse a redirect that points straight back at itself or at another redirect that leads back to it. If you still see a loop, check that your destination URL doesn't match one of your wildcards

Case sensitivity issues

URL paths are case-sensitive, so make sure you match the exact capitalization

Wrong redirect firing

The first match wins, so move the more specific redirect above any wildcard that also matches it

Pattern matching not working

Check you're only using * as a wildcard. Other pattern characters are treated as plain text

Redirects not saving

A redirect needs both From and To filled in, and neither can contain spaces. If we refuse one, we'll tell you why and put the row back as it was

Changes not showing

Try accessing the link in an incognito browser window to avoid cached versions or authentication issues that might mask the update

When troubleshooting redirects, try accessing the link in an incognito browser window to avoid cached versions or authentication issues that might mask the problem. If you're using pattern matching, start with simpler patterns and gradually add complexity.

What did you think of this doc?

Previous Setting a Custom Favicon Next Adding Custom JavaScript