About the Background Tasks API

Note for app developers: Wix Data APIs require the site's code editor to be enabled. If you are building a Wix app, add a data collections extension to automatically enable the code editor and create data collections when your app is installed on a site.

The Background Tasks API allows you to create and manage tasks that process data items. Tasks run in the background, so they don't block the user's ability to work on their site while items are processed.

Each task has a different type, which determines the kind of processing the task performs on the items of the specified collection. You can create tasks to:

  • Copy data from one field to another for all items in a collection.
  • Update field data for items that match a specified filter.
  • Delete all items in a collection that match a specified filter.
  • Update the publish status for items that match a specified filter.

Before you begin

It's important to note the following before starting to code:

  • To run a task of the type UPDATE_PUBLISH_STATUS, the collection must have the Publish plugin to control item visibility.

Use cases

Terminology

  • Field: Where item content is stored in a collection. Collections can have multiple fields. Learn more about collection fields.
  • Field type: The kind of content each field can contain. Learn more about field types.
  • Collection environment: Each collection can have two separate versions, one for testing and one for the live site. Learn more about working with sandbox and live collections.
  • Publish plugin: Allows items in a data collection to be marked as draft or published. Published items are visible to site visitors, while draft items are not. Learn more about controlling live site item visibility.
Did this help?