Skills Development System Lifecycle and Installation API

System Lifecycle and Installation API

v20260424
webiny-api-system-catalog
This API provides core abstractions for managing system initialization and lifecycle events. It includes `InstallSystemUseCase` for running system-wide setup logic, and `SystemInstalledEventHandler` for implementing hooks that execute immediately after the system is successfully installed. It is essential for developing robust, modular, and reliable large-scale applications requiring structured bootstrapping.
Get Skill
285 downloads
Overview

API — System

System installation event handlers and use cases.

How to Use

  1. Find the abstraction you need below
  2. You MUST read the source file to get the exact interface and types!
  3. Import: import { Name } from "<importPath>";
  4. See webiny-use-case-pattern or webiny-event-handler-pattern skills for implementation patterns

Abstractions


Name: InstallSystemUseCase Import: import { InstallSystemUseCase } from "webiny/api/system" Source: @webiny/api-core/features/system/InstallSystem/index.ts Description: Run system-wide installation.


Name: SystemInstalledEventHandler Import: import { SystemInstalledEventHandler } from "webiny/api/system" Source: @webiny/api-core/features/system/InstallSystem/index.ts Description: Hook into system lifecycle after the system is installed.


Info
Category Development
Name webiny-api-system-catalog
Version v20260424
Size 1KB
Updated At 2026-04-28
Language