Reference
Extensions
Reference for all webiny/extensions exports — React components used in webiny.config.tsx to wire extensions into the project.
- What extension components are available in
webiny/extensions? - What parameters does each extension accept?
- How to use each extension in your
webiny.config.tsx?
Overview
The webiny/extensions package exports React components used inside webiny.config.tsx to wire extensions into your Webiny project. Each component corresponds to a defineExtension() call in the Webiny source and accepts typed props defined by its Zod schema.
Api
Admin
Cli
Infra
Project
Api
Extension
Add any API extension.
Can be used multiple times.
BuildParam
Add build-time parameter to API app.
Can be used multiple times.
Admin
Extension
Extend the Admin application with custom functionality.
Can be used multiple times.
BuildParam
Add build-time parameter to Admin app.
Can be used multiple times.
Cli
Command
An extension for defining CLI commands.
Can be used multiple times.
Infra
Vpc
Apply VPC settings to AWS resources during deployment.
Can only be used once.
BlueGreenDeployments
Enable blue/green deployments for your Webiny project.
Can only be used once.
OpenSearch
Enable and configure Opensearch integration with project-level setup.
Can only be used once.
PulumiResourceNamePrefix
Adjust the prefix for Pulumi resource names (default: “wby-”).
Can only be used once.
ProductionEnvironments
Provide names for environments that are considered production environments.
Can be used multiple times.
EnvVar
Set an environment variable in the project context.
Can be used multiple times.
Aws.DefaultRegion
Set the default AWS region for the project.
Can only be used once.
Aws.Tags
Apply tags to AWS resources during deployment.
Can be used multiple times.
Admin.BeforeBuild
Add custom logic to be executed before the ADMIN build process.
Can be used multiple times.
Admin.BeforeDeploy
Add custom logic to be executed before the ADMIN deployment process.
Can be used multiple times.
Admin.BeforeWatch
Add custom logic to be executed before the Admin watch process.
Can be used multiple times.
Admin.AfterBuild
Add custom logic to be executed after the ADMIN build process.
Can be used multiple times.
Admin.AfterDeploy
Add custom logic to be executed after the ADMIN deployment process.
Can be used multiple times.
Admin.Pulumi
Modify Admin app’s cloud infrastructure using Pulumi.
Can be used multiple times.
Admin.CustomDomains
Configure custom domains for the Admin app.
Can only be used once.
Admin.StackOutputValue
Add custom output values to the Admin stack.
Can be used multiple times.
Api.BeforeBuild
Add custom logic to be executed before the API build process.
Can be used multiple times.
Api.BeforeDeploy
Add custom logic to be executed before the API deployment process.
Can be used multiple times.
Api.BeforeWatch
Add custom logic to be executed before the API watch process.
Can be used multiple times.
Api.AfterBuild
Add custom logic to be executed after the API build process.
Can be used multiple times.
Api.AfterDeploy
Add custom logic to be executed after the API deployment process.
Can be used multiple times.
Api.Pulumi
Modify Api app’s cloud infrastructure using Pulumi.
Can be used multiple times.
Api.StackOutputValue
Add custom output values to the Api stack.
Can be used multiple times.
Api.LambdaFunction
Add a custom Lambda function to the API app.
Can be used multiple times.
Core.BeforeBuild
Add custom logic to be executed before the CORE build process.
Can be used multiple times.
Core.BeforeDeploy
Add custom logic to be executed before the CORE deployment process.
Can be used multiple times.
Core.BeforeWatch
Add custom logic to be executed before the CORE watch process.
Can be used multiple times.
Core.AfterBuild
Add custom logic to be executed after the CORE build process.
Can be used multiple times.
Core.AfterDeploy
Add custom logic to be executed after the CORE deployment process.
Can be used multiple times.
Core.Pulumi
Modify Core app’s cloud infrastructure using Pulumi.
Can be used multiple times.
Core.StackOutputValue
Add custom output values to the Core stack.
Can be used multiple times.
Project
Id
An extension for defining the project ID.
Can only be used once.
Telemetry
This extension allows you to enable or disable telemetry for the project.
Can only be used once.
AutoInstall
Auto-install Webiny with admin user credentials on first deploy.
Can only be used once.
FeatureFlags
Enable or disable WCP features.
Can only be used once.