onOrderStarted( )

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.
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 order reaches its startDate. Applies to both purchased and free orders.

Permissions

Learn more about app permissions.

Method Declaration

Copy

Method Parameters

handlerfunction

handler(event: OrderStartedEnvelope): void | Promise<void>

Did this help?