Develop Websites
Build Apps
Go Headless
APIs and SDKs
Changelog
onEventStarted( )
Notes:
This method registers a callback function as an event handler.
When
developing websites
or
building apps with Blocks
, use a
Velo backend event
instead of this method.
When building apps not using Blocks, the way you call this method differs depending on the framework you are working in:
When using the
CLI
, run the
generate
command to
add an event extension
, and then call this method within the extension code.
When building a
self-hosted app
,
subscribe your app to the relevant event
, and then call this method on your server.
Triggered when an event has started.
Permissions
Read Events
Learn more about
app permissions
.
Method Declaration
Copy
Method Parameters
handler
function
handler(event: EventStartedEnvelope): void | Promise<void>
Show function Parameters
Did this help?
Yes
No