Headless CMS

Entry Event Handlers

Which event handlers are available in Headless CMS Entries and how to use them.

WHAT YOU'LL LEARN

Which event handlers are available for Entries?
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 Entry related operations, all of which are listed here.

Create an Entry

EntryBeforeCreateEventHandler

extensions/cms/entry/eventHandler/create/beforeCreate.ts

EntryAfterCreateEventHandler

extensions/cms/entry/eventHandler/create/afterCreate.ts

Create an Entry Revision

EntryRevisionBeforeCreateEventHandler

extensions/cms/entry/eventHandler/createFrom/beforeCreateFrom.ts

EntryRevisionAfterCreateEventHandler

extensions/cms/entry/eventHandler/createFrom/afterCreateFrom.ts

Update an Entry

EntryBeforeUpdateEventHandler

extensions/cms/entry/eventHandler/update/beforeUpdate.ts

EntryAfterUpdateEventHandler

extensions/cms/entry/eventHandler/update/afterUpdate.ts

Delete an Entry

EntryBeforeDeleteEventHandler

extensions/cms/entry/eventHandler/delete/beforeDelete.ts

EntryAfterDeleteEventHandler

extensions/cms/entry/eventHandler/delete/afterDelete.ts

Delete Multiple Entries

EntryBeforeDeleteMultipleEventHandler

extensions/cms/entry/eventHandler/deleteMultiple/beforeDeleteMultiple.ts

EntryAfterDeleteMultipleEventHandler

extensions/cms/entry/eventHandler/deleteMultiple/afterDeleteMultiple.ts

Delete an Entry Revision

EntryRevisionBeforeDeleteEventHandler

extensions/cms/entry/eventHandler/deleteRevision/beforeDeleteRevision.ts

EntryRevisionAfterDeleteEventHandler

extensions/cms/entry/eventHandler/deleteRevision/afterDeleteRevision.ts

Move an Entry

EntryBeforeMoveEventHandler

extensions/cms/entry/eventHandler/move/beforeMove.ts

EntryAfterMoveEventHandler

extensions/cms/entry/eventHandler/move/afterMove.ts

Publish an Entry

EntryBeforePublishEventHandler

extensions/cms/entry/eventHandler/publish/beforePublish.ts

EntryAfterPublishEventHandler

extensions/cms/entry/eventHandler/publish/afterPublish.ts

Republish an Entry

EntryBeforeRepublishEventHandler

extensions/cms/entry/eventHandler/republish/beforeRepublish.ts

EntryAfterRepublishEventHandler

extensions/cms/entry/eventHandler/republish/afterRepublish.ts

Unpublish an Entry

EntryBeforeUnpublishEventHandler

extensions/cms/entry/eventHandler/unpublish/beforeUnpublish.ts

EntryAfterUnpublishEventHandler

extensions/cms/entry/eventHandler/unpublish/afterUnpublish.ts

Restore an Entry From Bin

EntryBeforeRestoreFromBinEventHandler

extensions/cms/entry/eventHandler/restoreFromBin/beforeRestoreFromBin.ts

EntryAfterRestoreFromBinEventHandler

extensions/cms/entry/eventHandler/restoreFromBin/afterRestoreFromBin.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