skills.rest
webiny
webinyOFFICIAL
Explore all skills by this author →
Website𝕏@WebinyCMSGitHub

webiny-api-website-builder-catalog

Catalogs 58 Website Builder API abstractions for page and redirect management in Webiny.

8.0k|673|Updated Jan 9, 2018
Search Tags:#api#website builder#event handlers#redirects#Use Cases#pages#webiny
One-click install
npx skills add https://github.com/webiny/webiny-js --skill webiny-api-website-builder-catalog
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: webiny-api-website-builder-catalog
Source: https://github.com/webiny/webiny-js/tree/main/skills/user-skills/generated/api/website-builder
Command: npx skills add https://github.com/webiny/webiny-js --skill webiny-api-website-builder-catalog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

When extending Webiny's Website Builder on the API side, developers need to know which use cases and event handlers exist for pages and redirects without digging through the monorepo source. This Skill provides a single catalog of 58 abstractions with exact import paths and source file locations.

Core Features & Use Cases

  • Page Use Cases: Create, update, publish, unpublish, trash, restore, duplicate, move, and delete pages, plus listing and revision retrieval.
  • Redirect Use Cases: Create, update, move, delete, list, and schedule URL redirects, including cache invalidation.
  • Lifecycle Event Handlers: Before/after hooks for every page and redirect operation, enabling custom business logic injection.
  • Use Case: You need to run custom logic whenever a page is published. Look up PageAfterPublishEventHandler, read its source file for the exact interface, and register your handler implementation.

Quick Start

Ask the AI to find the Website Builder abstraction for publishing a page and show its import path and source file.

Frequently Asked Questions about webiny-api-website-builder-catalog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a page programmatically in Webiny Website Builder?▼

Use the CreatePageUseCase abstraction imported from webiny/api/website-builder/page. Read its source at @webiny/api-website-builder/features/pages/CreatePage/abstractions.ts to get the exact interface before implementing.

How to hook into page publish events in Webiny?▼

Implement PageBeforePublishEventHandler or PageAfterPublishEventHandler from webiny/api/website-builder/page. These handlers run before and after a page is published, letting you inject custom logic into the lifecycle.

Does Webiny Website Builder support scheduled publishing?▼

Yes, SchedulePublishPageUseCase and ScheduleUnpublishPageUseCase handle future page publishing and unpublishing. Equivalent use cases exist for redirects, all imported from webiny/api/website-builder/scheduler.

How do I manage URL redirects with the Webiny API?▼

Use the redirect use cases: CreateRedirectUseCase, UpdateRedirectUseCase, DeleteRedirectUseCase, ListRedirectsUseCase, and GetActiveRedirectsUseCase. InvalidateRedirectsCacheUseCase clears the redirect cache after changes.

What frontend frameworks does Webiny Website Builder rendering support?▼

The catalog lists NextjsConfig and NuxtConfig abstractions for configuring website rendering with Next.js and Nuxt. Both are defined in @webiny/api-website-builder features directories.

Related Skills

Explore More Software Engineering Skills→
webinywebiny
8.0k

backend-developer

Implement backend API features using Webiny architecture and GraphQL schemas.

Official
Advanced
mgd34msumgd34msu
4

keystonejs

Generate GraphQL APIs and Admin UIs from KeystoneJS schema definitions.

Community
Advanced
StartaleGroupStartaleGroup
3

creating-ui-components

Automate end-to-end creation of reusable React UI components with Chrome testing.

Official
Advanced
AINative-StudioAINative-Studio

ci-cd-compliance

Enforce CI/CD gate sequencing, merge policies, and deployment workflows.

Official
Intermediate