@valon-technologies/gestalt
    Preparing search index...

    Class Workflow

    Index

    Constructors

    constructor

    Methods

    connect applyDefinition applyDefinitionRaw getDefinition getDefinitionRaw listDefinitions listDefinitionsRaw setDefinitionPaused setDefinitionPausedRaw setActivationPaused setActivationPausedRaw deleteDefinition deleteDefinitionRaw startRun startRunRaw listRuns listRunsRaw getRun getRunRaw getRunEvents getRunEventsRaw getRunOutput getRunOutputRaw cancelRun cancelRunRaw signalRun signalRunRaw signalOrStartRun signalOrStartRunRaw deliverEvent deliverEventRaw

    Constructors

    • Parameters

      • transport: Transport
      • Optionaloptions: { context?: RequestContext; timeoutMs?: number }

      Returns Workflow

    Methods

    • Parameters

      • Optionaloptions: { name?: string; context?: RequestContext; timeoutMs?: number }

      Returns Workflow

    • Parameters

      • providerName: string
      • idempotencyKey: string
      • Optionalspec: {
            id?: string;
            target?: {
                steps?: {
                    id?: string;
                    inputs?: {
                        [key: string]: {
                            kind?:
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                        };
                    };
                    when?: {
                        value?: { kind?: ... };
                        equals?:
                            | string
                            | number
                            | boolean
                            | { [key: ...]: ... }
                            | (...)[]
                            | null;
                    };
                    timeoutSeconds?: number;
                    metadata?: {
                        [key: string]: | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (...)[]
                        | null;
                    };
                    action?: | { case: undefined; value?: undefined }
                    | {
                        case: "app";
                        value: {
                            name?: (...) | (...);
                            operation?: (...) | (...);
                            input?: (...) | (...);
                            connection?: (...) | (...);
                            instance?: (...) | (...);
                            credentialMode?: (...) | (...);
                        };
                    }
                    | {
                        case: "agent";
                        value: {
                            provider?: (...)
                            | (...);
                            model?: (...) | (...);
                            sessionKey?: (...) | (...);
                            prompt?: (...) | (...);
                            messages?: (...) | (...);
                            tools?: (...) | (...);
                            output?: (...) | (...);
                            modelOptions?: (...) | (...);
                        };
                    };
                }[];
            };
            activations?: {
                id?: string;
                input?: {
                    kind?: | { case: undefined; value?: undefined }
                    | {
                        case: "literal";
                        value: string | number | boolean | { [key: ...]: ... } | (...)[] | null;
                    }
                    | { case: "object"; value: { fields?: (...)
                    | (...) } }
                    | { case: "array"; value: { values?: (...) | (...) } }
                    | { case: "template"; value: { template?: (...) | (...) } }
                    | { case: "input"; value: { path?: (...) | (...) } }
                    | { case: "signal"; value: { path?: (...) | (...) } }
                    | {
                        case: "stepOutput";
                        value: { stepId?: (...) | (...); path?: (...) | (...) };
                    }
                    | {
                        case: "stepInput";
                        value: { stepId?: (...)
                        | (...); path?: (...) | (...) };
                    };
                };
                paused?: boolean;
                trigger?: | { case: undefined; value?: undefined }
                | { case: "schedule"; value: { cron?: string; timezone?: string } }
                | {
                    case: "event";
                    value: {
                        match?: {
                            type?: (...) | (...);
                            source?: (...) | (...);
                            subject?: (...) | (...);
                        };
                    };
                };
            }[];
            paused?: boolean;
            runAs?: {
                id?: string;
                credentialSubjectId?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
        }

      Returns Promise<WorkflowDefinition>

    • Parameters

      • request: {
            providerName?: string;
            spec?: {
                id?: string;
                target?: {
                    steps?: {
                        id?: string;
                        inputs?: { [key: string]: { kind?: ... } };
                        when?: {
                            value?: (...) | (...);
                            equals?: (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...);
                        };
                        timeoutSeconds?: number;
                        metadata?: {
                            [key: string]: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        };
                        action?: | { case: undefined; value?: undefined }
                        | {
                            case: "app";
                            value: {
                                name?: ...;
                                operation?: ...;
                                input?: ...;
                                connection?: ...;
                                instance?: ...;
                                credentialMode?: ...;
                            };
                        }
                        | {
                            case: "agent";
                            value: {
                                provider?: ...;
                                model?: ...;
                                sessionKey?: ...;
                                prompt?: ...;
                                messages?: ...;
                                tools?: ...;
                                output?: ...;
                                modelOptions?: ...;
                            };
                        };
                    }[];
                };
                activations?: {
                    id?: string;
                    input?: {
                        kind?: | { case: undefined; value?: undefined }
                        | {
                            case: "literal";
                            value: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                        }
                        | { case: "object"; value: { fields?: ... } }
                        | { case: "array"; value: { values?: ... } }
                        | { case: "template"; value: { template?: ... } }
                        | { case: "input"; value: { path?: ... } }
                        | { case: "signal"; value: { path?: ... } }
                        | { case: "stepOutput"; value: { stepId?: ...; path?: ... } }
                        | { case: "stepInput"; value: { stepId?: ...; path?: ... } };
                    };
                    paused?: boolean;
                    trigger?: | { case: undefined; value?: undefined }
                    | { case: "schedule"; value: { cron?: string; timezone?: string } }
                    | {
                        case: "event";
                        value: { match?: { type?: ...; source?: ...; subject?: ... } };
                    };
                }[];
                paused?: boolean;
                runAs?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
            };
            idempotencyKey?: string;
            requestedBySubjectId?: string;
            context?: {
                subject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        credentialSubjectId?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<WorkflowDefinition>

    • Parameters

      • request: {
            definitionId?: string;
            context?: {
                subject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        credentialSubjectId?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<WorkflowDefinition>

    • Parameters

      • request: {
            context?: {
                subject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        credentialSubjectId?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<WorkflowDefinition[]>

    • Parameters

      • request: {
            context?: {
                subject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        credentialSubjectId?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<ListWorkflowProviderDefinitionsResponse>

    • Parameters

      • definitionId: string
      • paused: boolean

      Returns Promise<WorkflowDefinition>

    • Parameters

      • request: {
            definitionId?: string;
            paused?: boolean;
            requestedBySubjectId?: string;
            context?: {
                subject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        credentialSubjectId?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<WorkflowDefinition>

    • Parameters

      • definitionId: string
      • activationId: string
      • paused: boolean

      Returns Promise<WorkflowDefinition>

    • Parameters

      • request: {
            definitionId?: string;
            activationId?: string;
            paused?: boolean;
            requestedBySubjectId?: string;
            context?: {
                subject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        credentialSubjectId?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<WorkflowDefinition>

    • Parameters

      • definitionId: string

      Returns Promise<void>

    • Parameters

      • request: {
            definitionId?: string;
            context?: {
                subject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        credentialSubjectId?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<void>

    • Parameters

      • idempotencyKey: string
      • workflowKey: string
      • providerName: string
      • definitionId: string
      • expectedDefinitionGeneration: bigint
      • OptionalrunAs: {
            id?: string;
            credentialSubjectId?: string;
            email?: string;
            displayName?: string;
            scopes?: string[];
            permissions?: {
                app?: string;
                operations?: string[];
                allOperations?: boolean;
            }[];
        }
      • Optionalinput: JsonObject

      Returns Promise<WorkflowRun>

    • Parameters

      • request: {
            idempotencyKey?: string;
            createdBySubjectId?: string;
            workflowKey?: string;
            providerName?: string;
            definitionId?: string;
            runAs?: {
                id?: string;
                credentialSubjectId?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            input?: {
                [key: string]: | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
            };
            expectedDefinitionGeneration?: bigint;
            context?: {
                subject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        credentialSubjectId?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<WorkflowRun>

    • Parameters

      • request: {
            pageSize?: number;
            pageToken?: string;
            status?: number;
            targetApp?: string;
            context?: {
                subject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        credentialSubjectId?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<ListWorkflowProviderRunsResponse>

    • Parameters

      • request: {
            runId?: string;
            context?: {
                subject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        credentialSubjectId?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<WorkflowRun>

    • Parameters

      • request: {
            runId?: string;
            context?: {
                subject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        credentialSubjectId?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<GetWorkflowProviderRunEventsResponse>

    • Parameters

      • runId: string

      Returns Promise<JsonValue | undefined>

    • Parameters

      • request: {
            runId?: string;
            context?: {
                subject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        credentialSubjectId?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<GetWorkflowProviderRunOutputResponse>

    • Parameters

      • runId: string
      • reason: string

      Returns Promise<WorkflowRun>

    • Parameters

      • request: {
            runId?: string;
            reason?: string;
            context?: {
                subject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        credentialSubjectId?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<WorkflowRun>

    • Parameters

      • runId: string
      • Optionalsignal: {
            id?: string;
            name?: string;
            payload?: {
                [key: string]:
                    | string
                    | number
                    | boolean
                    | (
                        { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                    )
                    | (
                        string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                    )[]
                    | null;
            };
            metadata?: {
                [key: string]: | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
            };
            createdBySubjectId?: string;
            createdAt?: Date;
            idempotencyKey?: string;
            sequence?: bigint;
        }

      Returns Promise<SignalWorkflowRunResponse>

    • Parameters

      • request: {
            runId?: string;
            signal?: {
                id?: string;
                name?: string;
                payload?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                metadata?: {
                    [key: string]: | string
                    | number
                    | boolean
                    | (
                        { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                    )
                    | (
                        string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                    )[]
                    | null;
                };
                createdBySubjectId?: string;
                createdAt?: Date;
                idempotencyKey?: string;
                sequence?: bigint;
            };
            context?: {
                subject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        credentialSubjectId?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<SignalWorkflowRunResponse>

    • Parameters

      • workflowKey: string
      • idempotencyKey: string
      • providerName: string
      • definitionId: string
      • expectedDefinitionGeneration: bigint
      • Optionalsignal: {
            id?: string;
            name?: string;
            payload?: {
                [key: string]:
                    | string
                    | number
                    | boolean
                    | (
                        { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                    )
                    | (
                        string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                    )[]
                    | null;
            };
            metadata?: {
                [key: string]: | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
            };
            createdBySubjectId?: string;
            createdAt?: Date;
            idempotencyKey?: string;
            sequence?: bigint;
        }
      • OptionalrunAs: {
            id?: string;
            credentialSubjectId?: string;
            email?: string;
            displayName?: string;
            scopes?: string[];
            permissions?: {
                app?: string;
                operations?: string[];
                allOperations?: boolean;
            }[];
        }
      • Optionalinput: JsonObject

      Returns Promise<SignalWorkflowRunResponse>

    • Parameters

      • request: {
            workflowKey?: string;
            idempotencyKey?: string;
            createdBySubjectId?: string;
            signal?: {
                id?: string;
                name?: string;
                payload?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                metadata?: {
                    [key: string]: | string
                    | number
                    | boolean
                    | (
                        { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                    )
                    | (
                        string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                    )[]
                    | null;
                };
                createdBySubjectId?: string;
                createdAt?: Date;
                idempotencyKey?: string;
                sequence?: bigint;
            };
            providerName?: string;
            definitionId?: string;
            runAs?: {
                id?: string;
                credentialSubjectId?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            input?: {
                [key: string]: | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
            };
            expectedDefinitionGeneration?: bigint;
            context?: {
                subject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        credentialSubjectId?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<SignalWorkflowRunResponse>

    • Parameters

      • Optionalevent: {
            id?: string;
            source?: string;
            specVersion?: string;
            type?: string;
            subject?: string;
            time?: Date;
            datacontenttype?: string;
            data?: {
                [key: string]:
                    | string
                    | number
                    | boolean
                    | (
                        { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                    )
                    | (
                        string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                    )[]
                    | null;
            };
            extensions?: {
                [key: string]: | string
                | number
                | boolean
                | {
                    [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
                }
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
            };
        }
      • Optionaloptions: { appName?: string; providerName?: string }

      Returns Promise<WorkflowEvent>

    • Parameters

      • request: {
            appName?: string;
            event?: {
                id?: string;
                source?: string;
                specVersion?: string;
                type?: string;
                subject?: string;
                time?: Date;
                datacontenttype?: string;
                data?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                extensions?: {
                    [key: string]: | string
                    | number
                    | boolean
                    | {
                        [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
                    }
                    | (
                        string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                    )[]
                    | null;
                };
            };
            deliveredBySubjectId?: string;
            providerName?: string;
            context?: {
                subject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: {
                    [key: string]:
                        | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (
                            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                        )[]
                        | null;
                };
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    credentialSubjectId?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        credentialSubjectId?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<WorkflowEvent>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods