Variables
What are Variables?
Most objects in your workspace, like accounts or transactions, can have variables. variables
allow you to store any additional information about that object.
Variable Definitions
For some objects like Routes or Connections, you can enforce which variables to pass to the object by using variable_definitions
.
For more on variable_definitions
, check out the definitions section.
Variable Encryption
If you have encryption enabled in your workspace, you can also encrypt data that goes into variables. You can do it by wrapping the value with double pipes || ||
, for example:
{
"name": "Acme inc.",
"type": "simple",
"variables": {
"company_tax_id": "||29826355932||" // data to encrypt.
}
}
This will encrypt it, and you'll get the following token id that you can later reuse in workflows.
{
"name": "Acme inc.",
"type": "simple",
"variables": {
"company_tax_id": "|-ENCRYPTED_MAY22_Qv4mHQ43nofsxtHp7Wy-|" // |-token_id-|
}
}
Usage
- In the UI, when you create or update an object, if it has the capability to store variables, it will be shown in the form.
- When creating an account, at the bottom of the form, you'll see a section called
Variables
.