index.md

---

title: downloads.onCreated
slug: Mozilla/Add-ons/WebExtensions/API/downloads/onCreated
page-type: webextension-api-event
tags:
  - API
  - Add-ons
  - Event
  - Extensions
  - Non-standard
  - Reference
  - WebExtensions
  - downloads
  - onCreated
browser-compat: webextensions.api.downloads.onCreated

---

{{AddonSidebar()}}

The onCreated() event of the {{WebExtAPIRef("downloads")}} API fires when a download begins, i.e. when {{WebExtAPIRef("downloads.download()")}} is successfully invoked.

The listener is passed the {{WebExtAPIRef('downloads.DownloadItem')}} object in question as a parameter.

Syntax

browser.downloads.onCreated.addListener(listener)
browser.downloads.onCreated.removeListener(listener)
browser.downloads.onCreated.hasListener(listener)

Events have three functions:

• addListener(callback)

  • : 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 a given listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

• function

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

    • downloadItem

      • : The {{WebExtAPIRef('downloads.DownloadItem')}} object in question.

Browser compatibility

{{Compat}}

Examples

Log the URL of items as they are downloaded:

function handleCreated(item) {
  console.log(item.url);
}

browser.downloads.onCreated.addListener(handleCreated);

{{WebExtExamples}}

Note: This API is based on Chromium's chrome.downloads API.