Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

ContactSign Up
Community Plugin
View plugin on GitHub


Node CI npm version npm dm npm dt

Gatsby plugin to add Honeybadger error tracking to your site.


npm install --save @honeybadger-io/gatsby-plugin-honeybadger

How to use

Add your API key in the plugin options in gatsby-config.js:

// gatsby-config.js
module.exports = {
  plugins: [
      resolve: `@honeybadger-io/gatsby-plugin-honeybadger`,
      options: {
        apiKey: 'YOUR_API_KEY',
        revision: `${Date.now()}`,
        assetsUrl: 'https://foobar.com/assets',
        environment: process.env.NODE_ENV


  • [apiKey] (String): the API key of your Honeybadger project.
  • [revision] (String): gatsby-plugin-honeybadger uses honeybadger-webpack to upload source maps to Honeybadger. options.revision needs to be unique as it is the identifier that connects your errors to your source maps.
  • [assetsURL] (String): The base URL to production assets (scheme://host/path). Used to grab source maps.
  • [environment] (String): Current environment. Used to indicate the environment where the error occurred. Optional, defaults to process.env.NODE_ENV.


This package is MIT licensed. See the MIT-LICENSE file in this folder for details.

© 2023 Gatsby, Inc.