System Integration API Patterns

v20260825

webiny-api-system-catalog

This module provides essential API abstractions for managing core system functionality and lifecycles. It includes the `InstallSystemUseCase` for executing system-wide installation routines and the `SystemInstalledEventHandler` for hooking into the system lifecycle immediately after successful installation. It is crucial for developers building robust, modular systems that require proper setup and event-driven logic.

API System Integration Development Use Cases Event Handling

Get Skill

137 downloads

Overview

API — System

System installation event handlers and use cases.

How to Use

Find the abstraction you need below
You MUST read the source file to get the exact interface and types!
Import: import { Name } from "<importPath>";
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 v20260825

Size 1009B

Source webiny/webiny-js

Updated At 2026-09-06