WorkflowEditingEmbedRequest

Mints an embed token for <ss-workflow-editor> — view and edit a workflow's data and documents. Token scopes: workflow:read, workflow:update, file:read, file:upload. Default TTL: 8 h. Max TTL: 8 h.

  • intent
    enum
    const:  
    workflow_editing
    required
    values
    • workflow_editing
  • workflowId
    Type: string Pattern: ^wf_[0-9a-z]{26}$
    required

    Prefixed lowercase ULID, e.g. wf_01jv8m7qfj6xj9gkz7a4s2h8e.

  • allowedOrigins
    Type: array string[]

    CORS-allowed origins. Always set this to your app's exact origin(s).

  • context
    Type: object

    Optional context attached to an embed token — typically the recipient's identity for participant-bound flows.

    • recipientEmail
      Type: stringFormat: email
      required
    • metadata
      Type: object

      Free-form caller-supplied metadata.

    • recipientName
      Type: string
  • expiresIn
    Type: integer

    Token lifetime in seconds. Defaults to 28800 (8 h); capped at 28800.