Build a config modifier schema

A config modifier is an operation that applies a set of custom instructions for processing incoming or outgoing data. Learn about operations.

Review common use cases of how and when to use config modifiers.

Creating a config modifier may sound intimidating. This reference guide breaks down the Redox-specific syntax to build a config modifier schema. It’s intended to teach you how to use the coding language.

You build a config modifier schema with keywords, which specify what action to take on the payload at a given point in time. Browse through this reference guide to learn how each individual keyword works.

If keywords exist at the same nesting level in a schema, they execute according to this listed execution order, not the order they appear in the schema itself. For example, if you add get above use in the schema, use still executes first.

1. omit
2. constant
3. references
4. use
5. get
6. properties or if or concat or switch or pipe or merge

   If used at the same level

   These are the same rule, and only one will execute at this level.

7. default
8. plugin

Keywords build on each other, so each one uses the previous keyword’s output as its input. For example, the output of use is the input of get.

You can use a comment keyword at any point in the schema. This is a free text field to add context for anyone reading the config modifier. The comment keyword isn’t used when processing the config modifier.

Comments may be placed anywhere in the schema.