Warning
You're browsing the documentation for an old version of Webiny. Consider upgrading your project to Webiny 5.41.x.
Core Development Concepts > Background Tasks
Background Task Management
You will learn about Background Tasks, how to create new definitions, how to trigger them and how to handle the task run.
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
The Background Tasks do not have a section in the Admin UI yet, so they are accessible only via the GraphQL API.
Queries
List All Background Task Definitions
List All Background Task Runs
List Background Task Logs
Mutations
Trigger a Background Task
Abort a Background Task
Permissions
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
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
List All Background Task Runs
Trigger a Background Task
Abort a Background Task
List Background Task Logs