Manage

User Preferences

Read user preferences inside a stub with the Manage Configs task. Authentication is handled automatically.

User preferences are stored on the user's profile. The current preferences include a flowpilot_settings object, which can be edited on the User Preferences page.

# Read preferences in a stub action

Add a Manage Configs task named get_user_preferences to the action:

Core forwards the action's authentication and org context to Manage automatically. You do not need to configure a token, credential, or API URL in the task. The environment running the stub must include the Core user-preferences task update.

# Result

The task returns the profile in payload.profile, including the saved preferences:

        {
  "success": true,
  "payload": {
    "profile": {
      "user_preferences": {
        "flowpilot_settings": {}
      }
    }
  }
}

      

This example shows only the relevant result fields. Other profile fields are also returned.

After checking that stubpost.tasks.get_user_preferences.success is true, use this value replacement in a later task in the same action:

        ~~stubpost.tasks.get_user_preferences.payload.profile.user_preferences

      

To read just the Flowpilot settings from this result, append .flowpilot_settings to the path. See Variable Substitution for using the returned object in task parameters.

# Read only Flowpilot settings

To return only the saved Flowpilot settings, change target_path to /rolodex/profile/flowpilot-settings, keeping operation as read.

The task then returns this result:

        {
  "success": true,
  "payload": {
    "flowpilot_settings": {}
  }
}

      

With the same task name, the value replacement becomes:

        ~~stubpost.tasks.get_user_preferences.payload.flowpilot_settings

      

# Supported operations and user identity

Only these two Rolodex targets are allowed, and both require operation: "read":

• /rolodex/profile
• /rolodex/profile/flowpilot-settings

Other Rolodex paths and write operations are rejected with rolodex_only_allows_reading_user_preferences.

The task reads the preferences of the user identified by the action's authentication. For system-triggered actions, this can be a system user rather than the person who originally interacted with the stub. The current task does not support selecting another user by user UUID, contact UUID, or another identifier.