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 typical sequence of events is like this:

onErrorOccurred can be fired at any time during the request. Also note that sometimes the sequence of events may differ from this: for example, in Firefox, on an HSTS upgrade, the onBeforeRedirect event will be triggered immediately after onBeforeRequest.

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.

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

To intercept resources loaded by a page (such as images, scripts, or stylesheets), the extension must have the host permission for the resource as well as for the main page requesting the resource. For example, if a page at "" loads an image from "", then an extension must have both host permissions if it is to intercept the image request.

Modifying requests

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.

Accessing security information

In the onHeadersReceived listener you can access the TLS properties of a request by calling getSecurityInfo(). To do this you must also pass "blocking" in the extraInfoSpec argument to the event's addListener().

You can read details of the TLS handshake, but can't modify them or override the browser's trust decisions.

Modifying responses

To modify the HTTP response bodies for a request, call webRequest.filterResponseData, passing it the ID of the request. This returns a webRequest.StreamFilter object that you can use to examine and modify the data as it is received by the browser.

To do this, you must have the "webRequestBlocking" API permission as well as the "webRequest" API permission and the host permission for the relevant host.



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.

An object describing a single X.509 certificate.
An array of HTTP headers. Each header is represented as an object with two properties: name and either value or binaryValue.
An object describing filters to apply to webRequest events.
Represents a particular kind of resource fetched in a web request.
An object describing the security properties of a particular web request.
An object that can be used to monitor and modify HTTP responses while they are being received.
Contains data uploaded in a URL request.


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


This function can be used to ensure that event listeners are applied correctly when pages are in the browser's in-memory cache.
Returns a webRequest.StreamFilter object for a given request.
Gets detailed information about the TLS connection associated with a given request.


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.
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.
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.
Fired when the HTTP response headers associated with a request have been received. You can use this event to modify HTTP response headers.
Fired when the server asks the client to provide authentication credentials. The listener can do nothing, cancel the request, or supply authentication credentials.
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.
Fired when a server-initiated redirect is about to occur.
Fired when a request is completed.
Fired when an error occurs.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
BlockingResponse Yes144548 Yes
CertificateInfo No No6262 No
HttpHeaders Yes144548 Yes
RequestFilter Yes144548 Yes
ResourceType44 No454831
SecurityInfo No No6262 No
StreamFilter No No5757 No
UploadData Yes144548 Yes
filterResponseData No No5757 No
getSecurityInfo No No6262 No
handlerBehaviorChanged Yes144548 Yes
onAuthRequired Yes1454 *54 * Yes
onBeforeRedirect Yes144648 Yes
onBeforeRequest Yes *14 *46 *48 * Yes *
onBeforeSendHeaders Yes *14 *45 *48 * Yes *
onCompleted Yes144548 Yes
onErrorOccurred Yes144548 Yes
onHeadersReceived Yes *14 *45 *48 * Yes *
onResponseStarted Yes144548 Yes
onSendHeaders Yes144548 Yes

Chrome incompatibilities


  • In Firefox requests can be redirected only if their original URL uses the http: or https: scheme.
  • In Firefox, events are not fired for system requests (for example, extension upgrades or searchbar suggestions). From Firefox 57 onwards, Firefox makes an exception for extensions that need to intercept webRequest.onAuthRequired for proxy authorization. See the documentation for webRequest.onAuthRequired.
  • In Firefox, if an extension wants to redirect a public (e.g. HTTPS) URL to an extension page, the extension's manifest.json file must contain a web_accessible_resources key that lists the URL for the extension page. Note that any website may then link or redirect to that url, and extensions should treat any input (POST data, for examples) as if it came from an untrusted source, just as a normal web page should.
  • In Firefox, starting from Firefox 52, some of the browser.webRequest.* APIs allow returning Promises that resolves webRequest.BlockingResponse asynchronously. In Chrome, only webRequest.onAuthRequired supports asynchronous webRequest.BlockingResponse via supplying 'asyncBlocking'.

Example extensions


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: JorisW, wbamberg, Zayed-Hossen, andrewtruongmoz, abbycar, andymckay
Last updated by: JorisW,