Key-Value Storage Trigger icon

Key-Value Storage Trigger

Key-Value Storage change listener

Key-Value Storage Trigger

AI-generated

Overview

This node acts as a trigger that listens for changes in a key-value storage system within n8n. It is designed to emit events when specific changes occur in the storage, such as additions, updates, or deletions, based on the configured scope and event types. This node is useful for workflows that need to react to changes in stored data, for example, triggering a workflow when a new key-value pair is added or an existing one is updated.

Use Case Examples

  1. Trigger a workflow when any key-value pair is added in the workflow scope.
  2. Listen for updates or deletions in the instance scope and process the changes accordingly.
  3. Monitor specific workflows by specifying their IDs to react only to changes related to those workflows.

Properties

Name Meaning
Scope Defines the scope of the key-value storage changes to listen for. Options include ALL scopes, Execution scope, Workflow scope, and Instance scope.
EventType Specifies which types of key-value storage events to receive. Options include ANY, Added, Updated, and Deleted.
Specifier A comma-separated list of Workflow IDs to filter events by specific workflows. This property is only applicable when the scope is set to Workflow.

Output

JSON

  • eventType - The type of event that triggered the node (e.g., added, updated, deleted).
  • key - The key in the key-value storage that was changed.
  • value - The new value associated with the key in the key-value storage.
  • scope - The scope in which the change occurred (e.g., workflow, instance).
  • specifier - The specifier string used to filter events, typically a list of workflow IDs.

Dependencies

  • Requires access to the key-value storage service within n8n.
  • No external API keys or credentials are explicitly required.

Troubleshooting

  • If no events are received, ensure the scope and event types are correctly configured to match the expected changes.
  • For manual trigger executions, a timeout error may occur if no event is received within 30 seconds. This is normal behavior to prevent indefinite waiting.
  • Ensure that the specifier list is correctly formatted as a comma-separated string when filtering by workflow IDs.

Discussion