Headless CMS
Model Event Handlers
Which event handlers are available in Headless CMS Models and how to use them.
WHAT YOU'LL LEARN
- Which event handlers are available for Models?
- How to use them?
- How to load them in your project?
Overview
Webiny Headless CMS provides events for users to hook into.
With the events you can hook into a number of different Model related operations, all of which are listed here.
Create a Model
ModelBeforeCreateEventHandler
extensions/cms/model/eventHandler/create/beforeCreate.ts
ModelAfterCreateEventHandler
extensions/cms/model/eventHandler/create/afterCreate.ts
Update a Model
ModelBeforeUpdateEventHandler
extensions/cms/model/eventHandler/update/beforeUpdate.ts
ModelAfterUpdateEventHandler
extensions/cms/model/eventHandler/update/afterUpdate.ts
Create a Model From Existing One
ModelBeforeCreateFromEventHandler
extensions/cms/model/eventHandler/createFrom/beforeCreateFrom.ts
ModelAfterCreateFromEventHandler
extensions/cms/model/eventHandler/createFrom/afterCreateFrom.ts
Delete a Model
ModelBeforeDeleteEventHandler
extensions/cms/model/eventHandler/delete/beforeDelete.ts
ModelAfterDeleteEventHandler
extensions/cms/model/eventHandler/delete/afterDelete.ts
Loading Event Handlers in Your Project
All the event handlers MUST be exported as default export from the file, otherwise it will not work.
To load the event handlers in your project, you need to add them in the root webiny.config.tsx file, like this:
webiny.config.tsx