The user object in Integry is meant to represent your end-users. You can use this object if you need to pass custom user-specific data to a Flow.
Defining user variables
By default, the user object has:
-
userID
(Required)- Used to associate a user's integrations with their account in your app.
-
apiKey
(Optional)- Can be used to authenticate HTTP calls to your app.
If you need to add additional user variables:
- Go to Workspace Settings -> Variables.
- Add the variables under User Variables.
Accessing user variables in a flow
You can reference all user variables in flow steps.
- In the body section of an HTTP Call step, click Add tag -> User Variables.
- Select the variable you want to use in the step. The values shown are only to help you map.
Don't worry about the values shown; they're from your test account and will be replaced with your user's values at run-time.
Passing user variables with the SDK
When you embed the marketplace widget, you pass the variables in the user object.
user: {
userId: "asim@integry.io",
apiKey: "453546546754",
}
Passing additional user variables with the SDK
The additional variables are also passed in the same user object.
user: {
userId: "asim@integry.io",
apiKey: "453546546754",
orgId: "12",
region: "North America",
}
FAQs
What happens if I pass an empty value for a user variable?
In order to protect you from accidentally breaking existing integrations (that may be using that user variable's existing value), we don't empty out the value of a user variable when you send an empty string ("").
If you really want to empty it, send a blank space (" ").