Persist Data Component

Persist small amounts of data that will be available later in the execution or in subsequent executions of the Instance
Component key: persist-data#
DescriptionThe persist data component provides functionality to persist small amounts of data for use during an integration execution or in subsequent integration executions. This is helpful if you want to save a bit of data during an integration invocation for use in a later step, or in a subsequent execution.
For details on how to persist data between flow invocations, see the building integrations article.
Data can be persisted in three ways:
- For just the duration of the execution.
Data persists ephemerally for only as long as a flow runs.
You might use the
Execution -
actions, for example, as an accumulator in a loop. - Between executions of a specific flow.
Data persists between instance executions and is scoped for a specific flow.
One flow cannot access another flow's data.
The
Flow -
actions are handy for saving data from one flow's run, and referencing it in a subsequent run of that same flow. - Globally, for all flows in an instance.
Data persists between instance executions and is scoped for the entire instance.
The
Cross Flow -
actions let flows within an instance reference one another's persisted data.
#
Actions#
Cross Flow - Add Value To SetAdd a value to the set with the specified key, creating the set as needed | key: addCrossFlowValueToSet
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be stored | Example Example Value |
#
Cross Flow - Append Value To ListAppend a value to the list with the specified key, creating the list as needed | key: appendCrossFlowValueToList
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be stored | Example Example Value |
#
Cross Flow - Decrement ValueDecrement the stored integer value with the specified key by the specified amount | key: decrementCrossFlowValue
Input | Default | Notes | Example |
---|---|---|---|
Input Amount data | Default 1 | Notes This is the amount that will be used for incrementing/decrementing | Example 1 |
Input Key data / Required | Default | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Cross Flow - Get ValueGet the value with the specified key, returning the specified default value if key not present | key: getCrossFlowValue
Input | Notes | Example |
---|---|---|
Input Default Value data | Notes This is the value that will be returned if there is no value present | Example Example Default Value |
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Output Example Payload{ "data": "Example Saved Value"}
#
Cross Flow - Increment ValueIncrement the stored integer value with the specified key by the specified amount | key: incrementCrossFlowValue
Input | Default | Notes | Example |
---|---|---|---|
Input Amount data | Default 1 | Notes This is the amount that will be used for incrementing/decrementing | Example 1 |
Input Key data / Required | Default | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Cross Flow - Remove ValueRemove the value with the specified key | key: removeCrossFlowValue
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Cross Flow - Remove Value From ListRemove the value from the list with the specified key | key: removeCrossFlowValueFromList
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be removed | Example Example Value |
#
Cross Flow - Remove Value From SetRemove the value from the set with the specified key | key: removeCrossFlowValueFromSet
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be removed | Example Example Value |
#
Cross Flow - Save Current TimeSave the current time in UTC using the specified key | key: saveCrossFlowCurrentTime
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Cross Flow - Save ValueSave a value with the specified key for use at a later time | key: saveCrossFlowValue
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be stored | Example Example Value |
#
Execution - Add Value To SetAdd a value to the set with the specified key, creating the set as needed | key: addExecutionValueToSet
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be stored | Example Example Value |
#
Execution - Append Value To ListAppend a value to the list with the specified key, creating the list as needed | key: appendExecutionValueToList
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be stored | Example Example Value |
#
Execution - Decrement ValueDecrement the stored integer value with the specified key by the specified amount | key: decrementExecutionValue
Input | Default | Notes | Example |
---|---|---|---|
Input Amount data | Default 1 | Notes This is the amount that will be used for incrementing/decrementing | Example 1 |
Input Key data / Required | Default | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Execution - Get ValueGet the value with the specified key, returning the specified default value if key not present | key: getExecutionValue
Input | Notes | Example |
---|---|---|
Input Default Value data | Notes This is the value that will be returned if there is no value present | Example Example Default Value |
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Output Example Payload{ "data": "Example Saved Value"}
#
Execution - Increment ValueIncrement the stored integer value with the specified key by the specified amount | key: incrementExecutionValue
Input | Default | Notes | Example |
---|---|---|---|
Input Amount data | Default 1 | Notes This is the amount that will be used for incrementing/decrementing | Example 1 |
Input Key data / Required | Default | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Execution - Remove ValueRemove the value with the specified key | key: removeExecutionValue
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Execution - Remove Value From ListRemove the value from the list with the specified key | key: removeExecutionValueFromList
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be removed | Example Example Value |
#
Execution - Remove Value From SetRemove the value from the set with the specified key | key: removeExecutionValueFromSet
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be removed | Example Example Value |
#
Execution - Save Current TimeSave the current time in UTC using the specified key | key: saveExecutionCurrentTime
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Execution - Save ValueSave a value with the specified key for use at a later time | key: saveExecutionValue
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be stored | Example Example Value |
#
Flow - Add Value To SetAdd a value to the set with the specified key, creating the set as needed | key: addInstanceValueToSet
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be stored | Example Example Value |
#
Flow - Append Value To ListAppend a value to the list with the specified key, creating the list as needed | key: appendInstanceValueToList
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be stored | Example Example Value |
#
Flow - Decrement ValueDecrement the stored integer value with the specified key by the specified amount | key: decrementInstanceValue
Input | Default | Notes | Example |
---|---|---|---|
Input Amount data | Default 1 | Notes This is the amount that will be used for incrementing/decrementing | Example 1 |
Input Key data / Required | Default | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Flow - Get ValueGet the value with the specified key, returning the specified default value if key not present | key: getInstanceValue
Input | Notes | Example |
---|---|---|
Input Default Value data | Notes This is the value that will be returned if there is no value present | Example Example Default Value |
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Output Example Payload{ "data": "Example Saved Value"}
#
Flow - Increment ValueIncrement the stored integer value with the specified key by the specified amount | key: incrementInstanceValue
Input | Default | Notes | Example |
---|---|---|---|
Input Amount data | Default 1 | Notes This is the amount that will be used for incrementing/decrementing | Example 1 |
Input Key data / Required | Default | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Flow - Remove ValueRemove the value with the specified key | key: removeInstanceValue
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Flow - Remove Value From ListRemove the value from the list with the specified key | key: removeInstanceValueFromList
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be removed | Example Example Value |
#
Flow - Remove Value From SetRemove the value from the set with the specified key | key: removeInstanceValueFromSet
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be removed | Example Example Value |
#
Flow - Save Current TimeSave the current time in UTC using the specified key | key: saveInstanceCurrentTime
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Flow - Save ValueSave a value with the specified key for use at a later time | key: saveInstanceValue
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be stored | Example Example Value |
#
Integration - Add Value To SetAdd a value to the set with the specified key, creating the set as needed | key: addIntegrationValueToSet
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be stored | Example Example Value |
#
Integration - Append Value To ListAppend a value to the list with the specified key, creating the list as needed | key: appendIntegrationValueToList
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be stored | Example Example Value |
#
Integration - Decrement ValueDecrement the stored integer value with the specified key by the specified amount | key: decrementIntegrationValue
Input | Default | Notes | Example |
---|---|---|---|
Input Amount data | Default 1 | Notes This is the amount that will be used for incrementing/decrementing | Example 1 |
Input Key data / Required | Default | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Integration - Get ValueGet the value with the specified key, returning the specified default value if key not present | key: getIntegrationValue
Input | Notes | Example |
---|---|---|
Input Default Value data | Notes This is the value that will be returned if there is no value present | Example Example Default Value |
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Output Example Payload{ "data": "Example Saved Value"}
#
Integration - Increment ValueIncrement the stored integer value with the specified key by the specified amount | key: incrementIntegrationValue
Input | Default | Notes | Example |
---|---|---|---|
Input Amount data | Default 1 | Notes This is the amount that will be used for incrementing/decrementing | Example 1 |
Input Key data / Required | Default | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Integration - Remove ValueRemove the value with the specified key | key: removeIntegrationValue
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Integration - Remove Value From ListRemove the value from the list with the specified key | key: removeIntegrationValueFromList
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be removed | Example Example Value |
#
Integration - Remove Value From SetRemove the value from the set with the specified key | key: removeIntegrationValueFromSet
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be removed | Example Example Value |
#
Integration - Save Current TimeSave the current time in UTC using the specified key | key: saveIntegrationCurrentTime
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
#
Integration - Save ValueSave a value with the specified key for use at a later time | key: saveIntegrationValue
Input | Notes | Example |
---|---|---|
Input Key data / Required | Notes This is the key that will be used to refer to the stored value | Example Example Key |
Input Value data / Required | Notes This is the value that will be stored | Example Example Value |