Event Generate
Introduction
Catalyst enables you to generate sample payloads for events associated with Catalyst Publishers in Catalyst Signals using the CLI.
The catalyst event:generate command generates sample payloads for Catalyst publihsers in the CLI. You can specify the particular publisher and the action that you require the payload for. You can use the generated payload to test the Event functions in your project from the local environment.
In addition to Event functions, you can also generate sample payloads and test the Integration functions in your project. The catalyst event:generate:integ command enables you to select the integration service, component source, and handler to generate the payload for.
You can then launch a Node shell from the CLI to test and debug the Event or Integration function, by passing the generated sample payload data to the function.
-
Both event generation commands in the CLI only generate sample payloads to help you test functions in the local environment. These actions will not be reflected in Signlas, Functions, or any components that you have configured in your project or in the remote console. They will remain unaffected.
-
Cliq Integration Functions is currently not available to Catalyst users accessing from the EU, AU, IN, or CA data centers. ConvoKraft Integration Functions are available to users accessing from all DCs.
-
If you are a Visual Studio Code IDE user, you can install the Catalyst Tools extension, and perform CLI operations using your IDE in place of the CLI. Steps to debug Event, Cron, and Integration functions using Visual Studio Code IDE can be found here.
Last Updated 2025-10-13 16:27:02 +0530 IST
Yes
No
Thank you for your feedback!
Send your feedback to us