Interface WorkflowInstanceCreateOptions<PARAMS>

interface WorkflowInstanceCreateOptions<PARAMS = unknown> {
    id?: string;
    params?: PARAMS;
    retention?: {
        errorRetention?: WorkflowSleepDuration;
        successRetention?: WorkflowSleepDuration;
    };
}

Properties

id?: string

An id for your Workflow instance. Must be unique within the Workflow.

params?: PARAMS

The event payload the Workflow instance is triggered with

retention?: {
errorRetention?: WorkflowSleepDuration;
successRetention?: WorkflowSleepDuration;
}

The retention policy for Workflow instance. Defaults to the maximum retention period available for the owner's account.