webRequest

Add event listeners for the various stages of making an HTTP request. The event listener receives detailed information about the request, and can modify or cancel the request.

Each event is fired at a particular stage of the request. The sequence of events is like this:

(onErrorOccurred can be fired at any time during the request.)

All the events, except onErrorOccurred, can take three arguments to addListener():

  • the listener itself
  • a filter object, so you can only be notified for requests made to particular URLs or for particular types of resource
  • an optional extraInfoSpec object. You can use this to pass additional event-specific instructions.

The listener function is passed a details object containing information about the request. This includes a request ID, which is provided to enable an add-on to correlate events associated with a single request. It is unique within a browser session and the add-on's context. It stays the same throughout a request, even across redirections and authentication exchanges.

On some of these events, you can modify the request. Specifically, you can:

To do this, you need to pass an option with the value "blocking" in the extraInfoSpec argument to the event's addListener(). This makes the listener synchronous. In the listener, you can then return a BlockingResponse object, which indicates the modification you need to make: for example, the modified request header you want to send.

To use the webRequest API for a given host, you must have the "webRequest" API permission and the host permission for that host. To use the "blocking" feature you must also have the "webRequestBlocking" API permission.

The webRequest API does not give you access to some security sensitive requests such as update checks and OCSP checks.

Types

webRequest.ResourceType
Represents a particular kind of resource fetched in a web request.
webRequest.RequestFilter
An object describing filters to apply to webRequest events.
webRequest.HttpHeaders
An array of HTTP headers. Each header is represented as an object with two properties: name and either value or binaryValue.
webRequest.BlockingResponse

An object of this type is returned by event listeners that have set "blocking" in their extraInfoSpec argument. By setting particular properties in BlockingResponse, the listener can modify network requests.

webRequest.UploadData
Contains data uploaded in a URL request.

Properties

webRequest.MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES
The maximum number of times that handlerBehaviorChanged() can be called in a 10 minute period.

Functions

webRequest.handlerBehaviorChanged()
This function can be used to ensure that event listeners are applied correctly when pages are in the browser's in-memory cache.

Events

webRequest.onBeforeRequest
Fired when a request is about to be made, and before headers are available. This is a good place to listen if you want to cancel or redirect the request.
webRequest.onBeforeSendHeaders
Fired before sending any HTTP data, but after HTTP headers are available. This is a good place to listen if you want to modify HTTP request headers.
webRequest.onSendHeaders
Fired just before sending headers. If your add-on or some other add-on modified headers in onBeforeSendHeaders, you'll see the modified version here.
webRequest.onHeadersReceived
Fired when the HTTP response headers associated with a request have been received. You can use this event to modify HTTP response headers.
webRequest.onAuthRequired
Fired when the server asks the client to provide authentication credentials. The listener can do nothing, cancel the request, or supply authentication credentials.
webRequest.onResponseStarted
Fired when the first byte of the response body is received. For HTTP requests, this means that the status line and response headers are available.
webRequest.onBeforeRedirect
Fired when a server-initiated redirect is about to occur.
webRequest.onCompleted
Fired when a request is completed.
webRequest.onErrorOccurred
Fired when an error occurs.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
BlockingResponse Yes Yes 45.0 48.0 33
HttpHeaders Yes Yes 45.0 48.0 33
MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES Yes No 45.0 48.0 33
RequestFilter Yes Yes 45.0 * 48.0 * 33
ResourceType Yes Yes 45.0 48.0 33
UploadData Yes Yes 45.0 48.0 33
handlerBehaviorChanged Yes Yes 45.0 48.0 33
onAuthRequired Yes Yes No No 33
onBeforeRedirect Yes * Yes 46.0 * 48.0 33 *
onBeforeRequest Yes * Yes 46.0 * 48.0 * 33 *
onBeforeSendHeaders Yes * Yes 45.0 * 48.0 33 *
onCompleted Yes * Yes 45.0 * 48.0 33 *
onErrorOccurred Yes * Yes 45.0 * 48.0 33 *
onHeadersReceived Yes * Yes 45.0 * 48.0 * 33 *
onResponseStarted Yes * Yes 45.0 * 48.0 33 *
onSendHeaders Yes * Yes 45.0 * 48.0 33 *

Chrome incompatibilities

webRequest

  • In Firefox requests can be redirected only if their original URL uses the http: or https: scheme.

Example add-ons

Acknowledgements

This API is based on Chromium's chrome.webRequest API. This documentation is derived from web_request.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: andymckay, wbamberg
 Last updated by: andymckay,