Warning
You're browsing the documentation for an old version of Webiny. Consider upgrading your project to Webiny 5.40.x.
Use with caution!
This feature is experimental and is subject to change in future releases.
Can I use this?

This feature is available since Webiny v5.39.0.

What you’ll learn
  • how to use Background Tasks GraphQL API
  • how to use programmatic API

GraphQL API
anchor

The Background Tasks do not have a section in the Admin UI yet, so they are accessible only via the GraphQL API.

Queries
anchor

List All Background Task Definitions
anchor

List All Background Task Runs
anchor

List Background Task Logs
anchor

Mutations
anchor

Trigger a Background Task
anchor

Abort a Background Task
anchor

Permissions
anchor

To execute the mutations and queries for the Background Tasks, the user must have a Full Access. In future releases we will fine grain the permissions.

Code API
anchor

For examples, we will assume you are somewhere in the code where you have access to the Webiny context object.

List All Background Task Definitions
anchor

List All Background Task Runs
anchor

Trigger a Background Task
anchor

Abort a Background Task
anchor

List Background Task Logs
anchor