Web API integration guide

Add Bugsnag to your ASP.NET Web API applications.


  • Install the Bugsnag package from Nuget.

Manual Library Reference

  • Download the latest Bugsnag.dll and reference it in your project

Bugsnag for .NET depends only on the JSON.net library and needs to be referenced, the nuget package can be found here.

Basic configuration

  1. Configure the Bugsnag integration inside your Web.config file

        <section name="bugsnagConfig" type="Bugsnag.ConfigurationStorage.ConfigSection, Bugsnag" />
      <bugsnagConfig apiKey="your-api-key-goes-here" />
  2. Import the Bugnsnag.Clients namespace into your application

    using Bugsnag.Clients;
  3. Inside the RegisterWebApiFilters function add the WebAPIClient error handler. Normally, this can be done in the App_Start > FilterConfig.cs file.


Reporting unhandled exceptions

After completing installation and basic configuration, unhandled exceptions will be automatically reported to your Bugsnag dashboard.

Reporting handled exceptions

If you would like to send non-fatal exceptions to Bugsnag, you can pass any object that inherits from Exception to the Notify method:

WebAPIClient.Notify(new ArgumentException("Non-fatal"));

Sending diagnostic data

It is often helpful to send us additional application-specific diagnostic data. This can be accomplished as per the following example:

var metadata = new Metadata();
metadata.AddToTab("Resources", "Datastore Entries", myDataStore.Count());
metadata.AddToTab("Resources", "Threads Running", threads.Count());
metadata.AddToTab("Resources", "Throttling Enabled", false);

WebAPIClient.Notify(new ArgumentException("Non-fatal"), metadata);

Customizing report severity

You can set the severity of an error in Bugsnag by including the severity option when notifying bugsnag of the error,

WebAPIClient.Notify(new ArgumentException("Non-fatal"), Severity.Info)

Valid severities are Severity.Error, Severity.Warning and Severity.Info.

Severity is displayed in the dashboard and can be used to filter the error list.

By default all crashes (or unhandled exceptions) are set to Severity.Error and all WebAPIClient.Notify() calls default to Severity.Warning.

Identifying users

The client can be configured to send the users ID, email and name with every notification. The user ID should be set to something unique to the user e.g. a generated GUID.

WebAPIClient.Config.SetUser("d7b4aadd", "anth.m@mycompany.com", "Anthony Michaels");

Session tracking

Bugsnag can track the number of “sessions” that happen in your application. This enables Bugsnag to provide and compare crash rates between releases to help you understand the quality of your releases.

Session tracking is coming soon to this platform.

Next steps