Built-in Background Tasks

Built-in Background Tasks

The following is a list of background tasks that are included in Webiny by default.

Amazon OpenSearch - Reindexing Background Task

The Reindexing Task is a background task that scans through the DynamoDB Elasticsearch table and pushes the data into the specific Elasticsearch/OpenSearch index. Internally it is a bit more than that, but this is the basic idea. You can check the definition and the runner code for more information.

The task can be triggered either via code or via the GraphQL API.

Triggering the Task via Code

Let’s say that you have a Page Builder lifecycle event hook which triggers the task when the page is published, but only on index which contains the word page in its name.

Triggering the Task via GraphQL API

The task can be triggered via the GraphQL API, with the following mutation:

The task disables indexing on all matching indexes, and enables it when the task is finished. This is done to reduce the strain on the Elasticsearch/OpenSearch cluster as the reindexing operation is a heavy one.

Amazon OpenSearch - Create Index Background Task

The Create Index background task is a task which creates all missing indexes in the Amazon OpenSearch cluster.

The task goes through all the CMS Models and creates indexes which do not exist. The task also creates Form Builder and Page Builder indexes.

The task can be triggered either via code or via the GraphQL API.

Triggering the Task via GraphQL API

Then you can check the task status and output with the following query: