Key Management Reference Guide

Check Key Value

Check if a Key is set on a particular User or Request.

Check Key Value Fields

• Object: The object that the key will be set on. Either User or Request.
• Key Name: The name of the key. Each key name should be unique across your whole platform.

Key Value: Set if you also want to check the key is set to a particular value. The Group will then route the conversation accordingly to the success or failure state configured.

Delete Key Value

This module deletes a key value from the current user or request.

Delete Key Value Fields

• Object: The object that the key is set on. Either User or Request.
• Keys: The names of the keys to be deleted.

Get Key Value

This module gets the key value that has been set on the current user or request.

Get Key Value Fields

• Object: The object that the key will be set on. Either User or Request.
• Key Name: The name of the key.

Inject Key Value

With this module, you can retrieve key values from chat users and inject them into states. This can be useful for storing user preferences and maintaining contextual data across workflows.

Storing User Preferences

You can store preferences against keys, and then pre-inject them into chat conversations to avoid asking the same questions again.

Maintaining Contextual Data across workflows.

Remember information that a chat user has specified across workflows/conversations), without having to ask again, or manually map across workflows.

Inject Key Value Fields

• Key Name: The name of the key. Each key name should be unique across your whole platform.
• State Name: Name of the state to inject the value into.
• Overwrite: Choose if you wish to override if there is already a value set in that state or not.

Set Key Value

Set a key value on the current user or request.

Set Key Value Fields

• Object: The object that the key will be set on. Either User or Request.
• Keys: An array of key/value pairs that will be set on the object.
• Key Name: The name of the key. Each key name should be unique across your whole platform.

Key Value: The value of the key. This item value can be manually entered or retrieved from another state or module using data references.