User properties

How to add and manage user properties

Overview

User properties enable you to store additional information about your users as key-value pairs. These properties can be used to segment users.

Default user properties

Flows automatically collects the following default user properties:

• updatedAt - timestamp when the user was last updated in Flows
• createdAt - timestamp when the user was created in Flows
• id - unique identifier of the user provided by you
• environment - environment (e.g., staging, production) associated with the user

Custom user properties

Custom user properties are additional fields that you can use to store information about your users. You can define these properties using the Flows SDK or API.

Property types

Custom user properties can be of the following types:

• string
• number
• boolean
• date - a date in ISO 8601 format

Adding custom user properties

To add custom user properties, use the Flows SDK as shown below:

import { FlowsProvider } from "@flows/react";
 
const App = () => {
  return (
    <FlowsProvider
      organizationId="your-organization-id" // Find this in Settings > General
      environment="your-environment"
      userId="your-user-id"
      userProperties={{
        customProperty: "value", // Add custom properties here
      }}
    >
      {/* Your app code here */}
    </FlowsProvider>
  );
};

Reserved property names

The following property names are reserved by Flows and cannot be used for custom user properties:

• updatedAt
• firstSeen
• id
• environment

View assigned user properties

To view a user’s properties:

1. Navigate to the Users page in Flows.
2. Search for the user by their unique ID.
3. View custom properties in the user detail page.

Using user properties

User properties can be used to segment users in workflows by creating conditions in blocks to filter users based on their properties. These blocks include:

• Start block - filter which users can enter a workflow
• Filter block - allow only users with specific properties to proceed