Circle V2 API Docs
    Preparing search index...

    Type Alias SubmitWorkflowRunParams

    type SubmitWorkflowRunParams = {
        fileUrl: string;
        metadata?: Record<string, unknown>;
        workflowId?: string;
    }
    Index

    Properties

    fileUrl: string

    Public/signed URL Extend can fetch the file from.

    metadata?: Record<string, unknown>

    Optional metadata echoed back on the resulting webhook events.

    workflowId?: string

    Workflow to run. Defaults to EXTEND_WORKFLOW_ID. Pass explicitly when the caller already knows which workflow is appropriate.