Fired when the HTTP response headers associated with a request have been received. You can use this event to modify HTTP response headers.

To have the response headers passed into the listener along with the rest of the request data, pass "responseHeaders" in the extraInfoSpec array.

To modify the headers, pass "blocking" in extraInfoSpec. Then in your event listener, return an object with a property named responseHeaders, whose value is the set of response headers to use. The browser will behave as if the server had sent the modified headers.

From Firefox 52 onwards, instead of returning BlockingResponse, the listener can return a Promise which is resolved with a BlockingResponse. This enables the listener to process the request asynchronously.

If you use "blocking", you must have the "webRequestBlocking" API permission in your manifest.json.

Note that it is possible for add-ons to conflict here. If two add-ons listen to onHeadersReceived for the same request, then the second listener will see modifications made by the first listener, and will be able to undo any changes made by the first listener. For example, if the first listener adds a Set-Cookie header, and the second listener strips all Set-Cookie headers, then the first listener's modifications will be lost. If you want to see the headers that are actually processed by the system, without the risk that another add-on will subsequently alter them, use onResponseStarted, although you can't modify headers on this event.


  listener,             // function
  filter,               //  object
  extraInfoSpec         //  optional array of strings

Events have three functions:

addListener(callback, filter, extraInfoSpec)
Adds a listener to this event.
Stop listening to this event. The listener argument is the listener to remove.
Check whether listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax



Function that will be called when this event occurs. The function will be passed the following arguments:

object. Details of the request. This will include response headers if you have included "responseHeaders" in extraInfoSpec.

Returns: webRequest.BlockingResponse. If "blocking" is specified in the extraInfoSpec parameter, the event listener should return a BlockingResponse object, and can set its responseHeaders property.

webRequest.RequestFilter. A set of filters that restricts the events that will be sent to this listener.
array of string. Extra options for the event. You can pass any of the following values:
  • "blocking" to make the request synchronous, so you can modify request headers
  • "responseHeaders" to include the response headers in the details object passed to the listener

Additional objects


string. The ID of the request. Request IDs are unique within a browser session, so you can use them to relate different events associated with the same request.
string. Target of the request.
string. Standard HTTP method: for example, "GET" or "POST".
integer. Zero if the request happens in the main frame; a positive value is the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (type is main_frame or sub_frame), frameId indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.
integer. ID of the frame that contains the frame which sent the request. Set to -1 if no parent frame exists.
integer. ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.
webRequest.ResourceType. The type of resource being requested: for example, "image", "script", "stylesheet".
number. The time when this event fired, in milliseconds since the epoch.
string. URL of the resource that triggered this request. Note that this may not be the same as the URL of the page into which the requested resource will be loaded. For example, if a document triggers a load in a different window through the target attribute of a link, or a CSS document includes an image using the url() functional notation, then this will be the URL of the original document or of the CSS document, respectively.
string. HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (that is, responses that lack a status line).
webRequest.HttpHeaders. The HTTP response headers that were received for this request.
integer. Standard HTTP status code returned by the server.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes Yes 45.0 48.0 33

Compatibility notes


  • 'originUrl' is not supported.
  • Asynchronous event listeners are not supported.


  • 'originUrl' is not supported.
  • Asynchronous event listeners are not supported.


  • Modification of the 'Content-Type' header is supported from version 51.
  • Asynchronous event listeners are supported from version 52.

Firefox for Android

  • Modification of the 'Content-Type' header is supported from version 51.
  • Asynchronous event listeners are supported from version 52.


  • 'originUrl' is not supported.
  • Asynchronous event listeners are not supported.


This code sets an extra cookie when requesting a resource from the target URL:

var targetPage = "https://developer.mozilla.org/en-US/Firefox/Developer_Edition";

// Add the new header to the original array,
// and return it.
function setCookie(e) {
  var setMyCookie = {
    name: "Set-Cookie",
    value: "my-cookie1=my-cookie-value1"
  return {responseHeaders: e.responseHeaders};

// Listen for onHeaderReceived for the target page.
// Set "blocking" and "responseHeaders".
  {urls: [targetPage]},
  ["blocking", "responseHeaders"]

This code does the same thing the previous example, except that the listener is asynchronous, returning a Promise which is resolved with the new headers:

var targetPage = "https://developer.mozilla.org/en-US/Firefox/Developer_Edition";

// Return a Promise that sets a timer.
// When the timer fires, resolve the promise with
// modified set of response headers.
function setCookieAsync(e) {
  var asyncSetCookie = new Promise((resolve, reject) => {
    window.setTimeout(() => {
      var setMyCookie = {
        name: "Set-Cookie",
        value: "my-cookie1=my-cookie-value1"
      resolve({responseHeaders: e.responseHeaders});
    }, 2000);

  return asyncSetCookie;

// Listen for onHeaderReceived for the target page.
// Set "blocking" and "responseHeaders".
  {urls: [targetPage]},
  ["blocking", "responseHeaders"]


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: wbamberg, Makyen, johnadungan
 Last updated by: wbamberg,