Mozilla's getting a new look. What do you think? https://mzl.la/brandsurvey

webRequest.onResponseStarted

Fired when the first byte of the response body is received.

This event is informational only.

Syntax

chrome.webRequest.onResponseStarted.addListener(
  function(             // function
    details               // object
  ) {...},
  filter,               //  object
  extraInfoSpec         //  optional array of strings
)
chrome.webRequest.onResponseStarted.removeListener(listener)
chrome.webRequest.onResponseStarted.hasListener(listener)

This API is also available as browser.webRequest.onResponseStarted.*.

Events have three functions:

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

addListener syntax

Parameters

callback

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

details
object. Details about the request. See details below.
filter
webRequest.RequestFilter. A filter that restricts the events that will be sent to this listener.
extraInfoSpecOptional
array of string. Extra options for the event. You can pass just one value:
  • "responseHeaders": include responseHeaders in the details object passed to the listener

Additional objects

details

requestId
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.
url
string. Target of the request.
method
string. Standard HTTP method: for example, "GET" or "POST".
frameId
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.
parentFrameId
integer. ID of the frame that contains the frame which sent the request. Set to -1 if no parent frame exists.
tabId
integer. The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.
type
webRequest.ResourceType. The type of resource being requested: for example, "image", "script", "stylesheet".
timeStamp
number. The time when this event fired, in milliseconds since the epoch.
originUrl
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.
ipOptional
string. The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address.
fromCache
boolean. Indicates if this response was fetched from disk cache.
statusCode
integer. Standard HTTP status code returned by the server.
responseHeadersOptional
webRequest.HttpHeaders. The HTTP response headers that were received along with this response.
statusLine
string. HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., responses that lack a status line) or an empty string if there are no headers.

Browser compatibility

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

Compatibility notes

Chrome

  • 'originUrl' is not supported.

Firefox

  • 'originUrl' is supported from version 48.

Opera

  • 'originUrl' is not supported.

Examples

var target = "https://developer.mozilla.org/*";

/*
e.g.
"https://developer.mozilla.org/en-US/Firefox/Releases"
200
HTTP/1.1 200 OK
*/
function logResponse(responseDetails) {
  console.log(responseDetails.url);
  console.log(responseDetails.statusCode);
  console.log(responseDetails.statusLine);
}

chrome.webRequest.onResponseStarted.addListener(
  logResponse,
  {urls: [target]}
);

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