---
canonical_url: "https://docs.composio.dev/toolkits/rulebricks"
markdown_url: "https://docs.composio.dev/toolkits/rulebricks.md"
product: "platform"
version: null
last_updated: null
---

# Rulebricks

Rulebricks is a decision automation platform for building, testing, publishing, and executing business rules and decision flows.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 59
- **Triggers:** 0
- **Slug:** `RULEBRICKS`
- **Version:** 00000000_00

## Tools

### Bulk Submit Context Data

**Slug:** `RULEBRICKS_BULK_SUBMIT_CONTEXT_DATA`

Merge a non-empty batch into a Rulebricks context and execute ready bound rules or flows. External effects and partial writes may occur; retrying after an uncertain response can repeat effects. Returns per-instance outcomes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include` | string | No | Comma-separated per-instance response fields to include. |
| `records` | array | Yes | Dynamic context records; each must carry the context identity fact. |
| `context_slug` | string | Yes | Context slug. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cascade Context Instance

**Slug:** `RULEBRICKS_CASCADE_CONTEXT_INSTANCE`

Re-evaluate registered pending rule and flow work for a Rulebricks context instance after dependencies may have become available. Flows may invoke external actions, and retrying an uncertain request can repeat their effects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `instance_id` | string | Yes | Context instance identity. |
| `context_slug` | string | Yes | Context slug. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Count Decision Logs

**Slug:** `RULEBRICKS_COUNT_DECISION_LOGS`

Count decision logs matching asset, status, trace, payload-content, or time-range filters without returning log payloads.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flows` | array | No | Flow names, IDs, or slugs whose flow-level execution logs to include. |
| `rules` | array | No | Rule names, IDs, or slugs to include. |
| `search` | string | No | Decision-data expression using comparisons, contains operators, and AND/OR, or a bare UUID/32-hex execution identifier. |
| `contexts` | array | No | Context names or slugs whose triggered executions to include. |
| `end_time` | string | No | Inclusive end of the decision time range in ISO 8601 format. |
| `statuses` | array | No | HTTP decision statuses to include. |
| `trace_id` | string | No | Count decisions associated with this execution-trace correlation identifier. |
| `start_time` | string | No | Inclusive start of the decision time range in ISO 8601 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Asset Test

**Slug:** `RULEBRICKS_CREATE_ASSET_TEST`

Create a saved test case for a Rulebricks rule or flow with an input, expected response, comparison policy, and criticality.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Test name. |
| `policy` | string ("contains" | "matches" | "excludes") | No | Response comparison policy; missing or null defaults to contains. |
| `request` | object | Yes | Input to send when running the test. |
| `critical` | boolean | Yes | Whether failure of this test should block a release. |
| `response` | object | Yes | Expected rule or flow response. |
| `asset_slug` | string | Yes | Slug of the rule or flow for which to create a test. |
| `asset_type` | string ("rule" | "flow") | Yes | Type of Rulebricks asset for which to create a test. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Context

**Slug:** `RULEBRICKS_CREATE_CONTEXT`

Create a Rulebricks context with stored and derived fields, an identity fact, retention settings, and access controls.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Context name; Rulebricks generates a unique slug from it. |
| `folder` | string | No | Context folder ID. |
| `schema` | object | Yes | Stored and derived field definitions. |
| `description` | string | No | Context description. |
| `ttl_seconds` | integer | No | Instance time-to-live in seconds; defaults to 86400. |
| `user_groups` | array | No | User groups allowed to access the context. |
| `history_limit` | integer | No | Maximum history entries retained per field; defaults to 100. |
| `identity_fact` | string | Yes | Key from schema.base that uniquely identifies instances. |
| `source_objects` | array | No | Workspace object IDs associated with the schema. |
| `on_schema_mismatch` | string ("ignore" | "reject" | "store") | No | Handling for fields outside the schema; defaults to ignore. |
| `auto_execute_decisions` | boolean | No | Whether bound rules and flows execute automatically; defaults to true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Context Relationship

**Slug:** `RULEBRICKS_CREATE_CONTEXT_RELATIONSHIP`

Create a has-many, has-one, or belongs-to relationship from one Rulebricks context to another.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Runtime relationship key; Rulebricks normalizes it to snake_case. |
| `context_id` | string | Yes | Unique identifier of the source context. |
| `description` | string | No | Relationship description. |
| `relation_type` | string ("has_many" | "has_one" | "belongs_to") | Yes | Cardinality and direction of the relationship. |
| `to_context_id` | string | Yes | Unique identifier of the target context. |
| `foreign_key_fact` | string | Yes | Source-context field key used as the foreign key. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Folder

**Slug:** `RULEBRICKS_CREATE_FOLDER`

Create a folder for rule, flow, or context assets; the asset type defaults to rule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Folder name. |
| `asset_type` | string ("rule" | "flow" | "context") | No | Type of assets organized by this folder; defaults to rule. |
| `description` | string | No | Folder description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create User

**Slug:** `RULEBRICKS_CREATE_USER`

Create a new user directly with a password, bypassing the email invitation flow. The user can immediately log in with the provided credentials. The provider-issued API key is omitted from the response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Display name for the user. |
| `role` | string | No | Role to assign to the user. Defaults to 'developer' if not specified. |
| `email` | string | Yes | Email address for the new user. |
| `password` | string | Yes | Password for the new user (minimum 8 characters). The user can log in immediately with this password. |
| `user_groups` | array | No | List of user group names or IDs to assign to the user. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create User Group

**Slug:** `RULEBRICKS_CREATE_USER_GROUP`

Create a new user group in your Rulebricks organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique name of the user group. |
| `description` | string | No | Description of the user group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Asset Test

**Slug:** `RULEBRICKS_DELETE_ASSET_TEST`

Permanently delete one saved test case from a Rulebricks rule or flow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `test_id` | string | Yes | ID of the test to delete. |
| `asset_slug` | string | Yes | Slug of the rule or flow that owns the test. |
| `asset_type` | string ("rule" | "flow") | Yes | Type of Rulebricks asset that owns the test. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Context

**Slug:** `RULEBRICKS_DELETE_CONTEXT`

Delete a Rulebricks context and all of its live instances, returning affected bindings and pending evaluations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `context_id` | string | Yes | Unique identifier of the context to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Context Instance

**Slug:** `RULEBRICKS_DELETE_CONTEXT_INSTANCE`

Permanently delete one Rulebricks context instance and its history, cancel its pending evaluations, and re-evaluate dependent context instances. Ready dependent rules or flows may execute; flows may invoke external actions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `instance_id` | string | Yes | Context instance identity. |
| `context_slug` | string | Yes | Context slug. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Context Relationship

**Slug:** `RULEBRICKS_DELETE_CONTEXT_RELATIONSHIP`

Delete a specific relationship owned by a Rulebricks context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `context_id` | string | Yes | Unique identifier of the context that owns the relationship. |
| `relationship_id` | string | Yes | Unique identifier of the relationship to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Flow

**Slug:** `RULEBRICKS_DELETE_FLOW`

Permanently delete one Rulebricks flow by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | string | Yes | ID of the flow to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Folder

**Slug:** `RULEBRICKS_DELETE_FOLDER`

Delete one folder by ID without deleting the assets it contains.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | Yes | ID of the folder to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Object

**Slug:** `RULEBRICKS_DELETE_OBJECT`

Delete a workspace object by ID or exact name and archive, delete, or detach its generated values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `values` | string ("archive" | "detach") | No | Handling for generated values: omit or use archive to delete unused values and archive referenced values; use detach to retain all values. |
| `object_id` | string | Yes | Object ID or exact object name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Rule

**Slug:** `RULEBRICKS_DELETE_RULE`

Permanently delete one Rulebricks rule by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule_id` | string | Yes | ID of the rule to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Value

**Slug:** `RULEBRICKS_DELETE_VALUE`

Delete one vocabulary value by ID and replace references from other values with its content; rule or flow references and object-managed namespaces can block deletion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value_id` | string | Yes | ID of the vocabulary value to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Execute Assets in Parallel

**Slug:** `RULEBRICKS_EXECUTE_ASSETS_IN_PARALLEL`

Execute multiple published Rulebricks rules or flows in parallel from one named map. Each entry is independent, so successful results are returned alongside reserved `$error` details for entries that fail. Flows may invoke external actions, and retrying an uncertain request can repeat their effects. A successful call uses the organization's monthly execution allowance for each entry.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `executions` | object | Yes | Named rule or flow executions. Each value is its dynamic input payload with either `$rule` or `$flow` at the same level. The selector value is a published slug, optionally suffixed with `/{version}` or a release environment, such as `pricing/3` or `pricing/production`; a bare slug uses the current published version. `$rule` and `$flow` cannot be top-level map keys. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Execute Bulk Rule

**Slug:** `RULEBRICKS_EXECUTE_BULK_RULE`

Execute one published Rulebricks rule against up to 1000 ordered input objects and return one aligned result per input. A successful call uses the organization's monthly execution allowance for each input.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `version` | string | No | Numeric version, release environment slug, or latest. |
| `payloads` | array | Yes | Ordered rule input objects, each matching the rule's request schema; maximum 1000. |
| `rule_slug` | string | Yes | Published rule slug to execute. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Execute Flow

**Slug:** `RULEBRICKS_EXECUTE_FLOW`

Execute a published Rulebricks flow once or in bulk and return the ordered flow-defined output and execution ID for querying its decision logs. A flow may invoke external actions, and retrying an uncertain request can repeat their effects. A successful execution uses the organization's monthly execution allowance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payload` | string | Yes | One flow input object, or a list of input objects for bulk execution. Each object must match the flow's request schema. |
| `version` | string | No | Numeric version, release environment slug, or latest. |
| `flow_slug` | string | Yes | Published flow slug to execute. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Execute Rule

**Slug:** `RULEBRICKS_EXECUTE_RULE`

Execute a published Rulebricks rule with its input payload and return the rule-defined decision output. A successful execution uses the organization's monthly execution allowance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payload` | object | Yes | Rule input fields as a JSON object matching the rule's request schema. |
| `version` | string | No | Numeric version, release environment slug, or latest. |
| `rule_slug` | string | Yes | Published rule slug to execute. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Flow

**Slug:** `RULEBRICKS_EXPORT_FLOW`

Export one flow as a Rulebricks Flow Schema document that can be round-tripped through the flow import endpoint. Provide flow_id or flow_slug; at least one is required, and the provider accepts both together.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | string | No | ID of the flow to export. Provide flow_id or flow_slug; either or both are accepted. |
| `flow_slug` | string | No | Slug of the flow to export. Provide flow_id or flow_slug; either or both are accepted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Asset Manifest

**Slug:** `RULEBRICKS_EXPORT_MANIFEST`

Export selected Rulebricks rules, flows, contexts, or values with their resolved dependencies, or preview the export. Provide at least one of root_ids, root_collection, root_collections, or all_values=true for value catalogs; selectors may be combined.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("rbm" | "json") | No | Export format. json is supported only for root_type=value with download=true; rbm preserves the complete manifest. |
| `compress` | boolean | No | Return the manifest as a compress-json array. |
| `download` | boolean | No | Request direct-download mode; the tool returns the downloaded JSON under manifest. Required when format is json. |
| `root_ids` | array | No | IDs of root assets to export. At least one of root_ids, root_collection, root_collections, or all_values=true is required. |
| `root_type` | string ("rule" | "flow" | "context" | "value") | Yes | Type of root asset to export. |
| `all_values` | boolean | No | For root_type=value, export every accessible active, non-function, user-managed value without IDs or collection paths. Set true as at least one required root selector. |
| `preview_only` | boolean | No | Return an export preview without full asset data. |
| `root_version` | string | No | For one rule or flow root, export the draft, latest published version, or a positive published version number. |
| `manifest_name` | string | No | Exported file name. |
| `root_collection` | string | No | One value collection path to export. At least one of root_ids, root_collection, root_collections, or all_values=true is required. |
| `root_collections` | array | No | Value collection paths to export together. At least one of root_ids, root_collection, root_collections, or all_values=true is required. |
| `include_downstream` | boolean | No | For a context export, include rules and flows bound to the context. |
| `manifest_description` | string | No | Exported manifest description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Rule

**Slug:** `RULEBRICKS_EXPORT_RULE`

Export one rule by ID as a raw rule document that can be round-tripped through the Rulebricks rule import endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule_id` | string | Yes | ID of the rule to export. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Context

**Slug:** `RULEBRICKS_GET_CONTEXT`

Retrieve a Rulebricks context by ID, including its schema, bindings, access controls, and relationships.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `context_id` | string | Yes | Unique identifier of the context to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Context Instance

**Slug:** `RULEBRICKS_GET_CONTEXT_INSTANCE`

Retrieve the current base facts, derived facts, status, and selected execution or relationship data for one Rulebricks context instance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include` | string | No | Comma-separated fields: positions, is_new, status, have, need, state, derived, expires_at, created_at, updated_at, executions, executed, triggered, reason, cascaded, relations, or execution_results. Context is always returned; relations require include_relations and history uses GET_CONTEXT_INSTANCE_HISTORY. |
| `instance_id` | string | Yes | Context instance identity. |
| `context_slug` | string | Yes | Context slug. |
| `include_relations` | string | No | Comma-separated relationship names to include, or * for all. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Context Instance History

**Slug:** `RULEBRICKS_GET_CONTEXT_INSTANCE_HISTORY`

Retrieve newest-first historical values for all fields or one selected field on a Rulebricks context instance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `field` | string | No | Return history for only this field key. |
| `limit` | integer | No | Maximum history entries to return. |
| `instance_id` | string | Yes | Context instance identity. |
| `context_slug` | string | Yes | Context slug. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Object

**Slug:** `RULEBRICKS_GET_OBJECT`

Fetch one workspace object (JSON Schema) by its ID or exact name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `object_id` | string | Yes | Object ID or exact object name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Usage

**Slug:** `RULEBRICKS_GET_USAGE`

Return the organization's current plan and monthly Rulebricks execution usage, limit, and remaining allowance.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Flow

**Slug:** `RULEBRICKS_IMPORT_FLOW`

Create or update a flow from a Rulebricks Flow Schema document; imported flows publish by default unless publish (provider field _publish) is false.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow` | object | Yes | Rulebricks Flow Schema document with dynamic node configuration and connections; provider field casing is preserved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Asset Manifest

**Slug:** `RULEBRICKS_IMPORT_MANIFEST`

Atomically create or update rules, flows, contexts, and values from a Rulebricks manifest. Override updates conflicts in place while preserving prior versions, release pins, context records, IDs, folders, and access groups. Use PREVIEW_IMPORT_MANIFEST to inspect the write-free plan first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `manifest` | string | No | Rulebricks manifest object or compress-json array to import. |
| `import_id` | string | No | Idempotency UUID for retrying the same manifest and options. Reuse it after an uncertain response so a completed import is not repeated. |
| `clear_history` | boolean | No | Legacy option accepted but ignored by Rulebricks. Existing history is always preserved and source edit diffs are never replayed. |
| `manifest_upload` | object | No | Uploaded large-manifest reference from UPLOAD_MANIFEST_PART. Use instead of manifest. |
| `parent_folder_id` | string | No | Parent folder ID for imported asset folders. |
| `conflict_strategy` | string ("override" | "block") | No | How to handle existing assets. 'override' updates them in place and appends versions while preserving prior versions, release pins, context records, IDs, slugs, folders, and access groups; 'block' rejects the entire atomic import when any asset conflicts. |
| `compressed_request` | object | No | Gzip-compressed JSON ImportManifestRequest file. Use instead of manifest or manifest_upload; the compressed JSON must contain all import options. |
| `target_folder_name` | string | No | Folder name in which to place imported assets. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Rule

**Slug:** `RULEBRICKS_IMPORT_RULE`

Create a rule from a complete raw rule document, or partially update an existing rule when the document includes its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule` | object | Yes | Raw Rulebricks rule document. Provider field casing such as requestSchema, sampleRequest, and createdAt is preserved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Invite User

**Slug:** `RULEBRICKS_INVITE_USER`

Invite a new user to the organization or update role or user group data for an existing user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string | No | System or custom role ID to assign to the user. Available system roles include 'admin', 'editor', and 'developer'. |
| `email` | string | Yes | Email of the user to invite. |
| `user_groups` | array | No | List of user group names or IDs to assign to the user. All specified groups must exist in your organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Asset Tests

**Slug:** `RULEBRICKS_LIST_ASSET_TESTS`

List saved test cases for a Rulebricks rule or flow, including expected responses and latest execution state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `asset_slug` | string | Yes | Slug of the rule or flow whose tests to list. |
| `asset_type` | string ("rule" | "flow") | Yes | Type of Rulebricks asset whose tests to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Context Relationships

**Slug:** `RULEBRICKS_LIST_CONTEXT_RELATIONSHIPS`

List incoming and outgoing relationships configured for a Rulebricks context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `context_id` | string | Yes | Unique identifier of the context whose relationships to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contexts

**Slug:** `RULEBRICKS_LIST_CONTEXTS`

List contexts visible to the connected API key, optionally filtered or paginated by the provider's opaque cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Case-insensitive context-name substring filter. |
| `limit` | integer | No | Page size. Supplying it enables the paginated response form. |
| `cursor` | string | No | Opaque cursor from the previous page; requires limit. |
| `folder` | string | No | Folder name or ID used to filter contexts. |
| `user_group` | string | No | Accessible user-group name or ID used to filter contexts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Flows

**Slug:** `RULEBRICKS_LIST_FLOWS`

List flows visible to the connected API key, optionally selecting an exact asset version or filtering by identifier, search, folder, labels, group, or name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Flow name filter. |
| `folder` | string | No | Folder identifier or name used to filter flows. |
| `labels` | array | No | Labels that matching flows must have. |
| `search` | string | No | Exact flow ID or slug, or a case-insensitive flow-name substring. |
| `flow_id` | string | No | Exact flow ID to return. |
| `version` | string | No | Published version number, release environment slug, or latest. Requires the other filters to identify exactly one flow. |
| `flow_slug` | string | No | Exact case-sensitive flow slug to return. |
| `user_group` | string | No | User-group identifier used to restrict visible flows. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Folders

**Slug:** `RULEBRICKS_LIST_FOLDERS`

List asset folders visible to the connected API key, optionally filtered by user group or name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Folder name filter. |
| `user_group` | string | No | User-group identifier used to restrict visible folders. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Objects

**Slug:** `RULEBRICKS_LIST_OBJECTS`

List workspace objects (JSON Schemas) visible to the connected API key's user groups.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pending Context Evaluations

**Slug:** `RULEBRICKS_LIST_PENDING_CONTEXT_EVALUATIONS`

List rule and flow evaluations registered as pending for one Rulebricks context instance, including their missing dependencies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `instance_id` | string | Yes | Context instance identity. |
| `context_slug` | string | Yes | Context slug. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Rules

**Slug:** `RULEBRICKS_LIST_RULES`

List rules visible to the connected API key, optionally selecting an exact asset version or filtering by identifier, search, folder, labels, group, or name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Rule name filter. |
| `folder` | string | No | Folder identifier or name used to filter rules. |
| `labels` | array | No | Labels that matching rules must have; sent as one comma-separated filter. |
| `search` | string | No | Exact rule ID or slug, or a case-insensitive rule-name substring. |
| `rule_id` | string | No | Exact rule ID to return. |
| `version` | string | No | Published version number, release environment slug, or latest. Requires the other filters to identify exactly one rule. |
| `rule_slug` | string | No | Exact case-sensitive rule slug to return. |
| `user_group` | string | No | User-group identifier used to restrict visible rules. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Groups

**Slug:** `RULEBRICKS_LIST_USER_GROUPS`

List all user groups available in your Rulebricks organization.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `RULEBRICKS_LIST_USERS`

List all users (including the admin and all team members) in the organization with their email, name, role, user groups, and join date. Provider-issued API keys are omitted from the response.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Values

**Slug:** `RULEBRICKS_LIST_VALUES`

Return one page of vocabulary values visible to the connected API key, with optional name, prefix, type, group, and usage filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Text that matching vocabulary value names must contain. |
| `limit` | integer | No | Maximum vocabulary values to return in this page (1-1000). |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call. Pass it back unchanged. |
| `prefix` | string | No | Name prefix used to filter vocabulary values. |
| `include` | string | No | Set to usage to include the rules that reference each vocabulary value. |
| `resolve` | boolean | No | Whether to replace value references with their resolved values. Set false to return stored reference markers. |
| `user_group` | string | No | User-group identifier or name used to restrict visible values. |
| `value_type` | string ("string" | "number" | "boolean" | "date" | "list" | "function") | No | Vocabulary value type to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Preview Asset Manifest Import

**Slug:** `RULEBRICKS_PREVIEW_IMPORT_MANIFEST`

Return the server-authoritative plan for importing Rulebricks rules, flows, contexts, and values without writing any assets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `manifest` | string | No | Rulebricks manifest object or compress-json array to import. |
| `import_id` | string | No | Idempotency UUID for retrying the same manifest and options. Reuse it after an uncertain response so a completed import is not repeated. |
| `clear_history` | boolean | No | Legacy option accepted but ignored by Rulebricks. Existing history is always preserved and source edit diffs are never replayed. |
| `manifest_upload` | object | No | Uploaded large-manifest reference from UPLOAD_MANIFEST_PART. Use instead of manifest. |
| `parent_folder_id` | string | No | Parent folder ID for imported asset folders. |
| `conflict_strategy` | string ("override" | "block") | No | How to handle existing assets. 'override' updates them in place and appends versions while preserving prior versions, release pins, context records, IDs, slugs, folders, and access groups; 'block' rejects the entire atomic import when any asset conflicts. |
| `compressed_request` | object | No | Gzip-compressed JSON ImportManifestRequest file. Use instead of manifest or manifest_upload; the compressed JSON must contain all import options. |
| `target_folder_name` | string | No | Folder name in which to place imported assets. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Preview Value Collection Sync

**Slug:** `RULEBRICKS_PREVIEW_SYNC_VALUES`

Preview the created, updated, unchanged, archived, and deleted values for one complete single-request collection synchronization without writing changes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `values` | object | Yes | Complete desired membership keyed relative to the collection. An empty object previews emptying the collection. |
| `metadata` | object | No | Custom metadata that would be applied, keyed by full value name including the collection prefix. |
| `collection` | string | Yes | Collection path to preview synchronizing; only values beneath this path are considered. |
| `user_groups` | array | No | User-group names that would be assigned to submitted values. |
| `permanently_delete` | boolean | No | Preview marking omitted values deleted instead of archived. Requires the delete-values entitlement. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Preview Object Upsert

**Slug:** `RULEBRICKS_PREVIEW_UPSERT_OBJECT`

Validate and preview creating or updating a workspace object and synchronizing its JSON Schema enum values without writing any changes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Object ID that would be updated. |
| `name` | string | No | Object name; required when id is omitted. |
| `content` | string | Yes | JSON Schema object or serialized JSON string to validate and preview. |
| `user_groups` | array | No | User groups that would be applied to the object and generated values. |
| `field_rename` | object | No | One field rename whose generated value ID preservation should be previewed. |
| `expected_updated_at` | string | No | Report a conflict if the object's updated_at timestamp has changed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Decision Logs

**Slug:** `RULEBRICKS_QUERY_DECISION_LOGS`

Return one page of decision logs filtered by assets, status, trace, payload content, or time range. Check limited even when no next cursor is returned; a limited page does not cover all matching history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flows` | array | No | Flow names, IDs, or slugs whose flow-level execution logs to include. |
| `limit` | integer | No | Maximum decision logs to return in this page (1-1000). |
| `rules` | array | No | Rule names, IDs, or slugs to include. Names match partially; IDs and slugs match exactly. |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call. Pass it back unchanged. |
| `search` | string | No | Decision-data expression using comparisons, contains operators, and AND/OR, or a bare UUID/32-hex execution identifier. |
| `sort_by` | string ("time" | "name" | "status" | "type") | No | Field used to sort matching decisions. |
| `contexts` | array | No | Context names or slugs whose triggered rule and flow executions to include. |
| `end_time` | string | No | Inclusive end of the decision time range in ISO 8601 format. |
| `statuses` | array | No | HTTP decision statuses to include. The values are combined into a status filter. |
| `trace_id` | string | No | Return decisions associated with this execution-trace correlation identifier. |
| `sort_order` | string ("asc" | "desc") | No | Ascending or descending result order. |
| `start_time` | string | No | Inclusive start of the decision time range in ISO 8601 format. |
| `item_filter` | string | No | Exact bulk payload-item filter in path=value form, such as customer.id=cst_123. |
| `include_traces` | boolean | No | Whether to include potentially large execution path traces in flow decision logs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Value Metadata

**Slug:** `RULEBRICKS_REPLACE_VALUE_METADATA`

Replace or clear all custom metadata for one vocabulary value by ID without resending its value payload. The API key must have edit-values permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `metadata` | object | Yes | Complete replacement custom metadata. Send an empty object to clear all custom metadata. |
| `value_id` | string | Yes | ID of the vocabulary value whose custom metadata will be replaced. |
| `previous_metadata` | object | No | Expected current custom metadata. Rulebricks rejects the write if it no longer matches. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Asset Tests

**Slug:** `RULEBRICKS_RUN_ASSET_TESTS`

Run all saved tests, or only critical tests, against the latest draft of a Rulebricks rule or flow and return pass totals and failure diagnostics. Version targeting is not supported.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `asset_slug` | string | Yes | Slug of the rule or flow whose tests to run. |
| `asset_type` | string ("rule" | "flow") | Yes | Type of Rulebricks asset whose tests to run. |
| `critical_only` | boolean | No | Run only critical tests when true; omit to run the full suite. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Solve Context Asset

**Slug:** `RULEBRICKS_SOLVE_CONTEXT_ASSET`

Persist optional facts and execute one rule or flow bound to a Rulebricks context instance, or register it pending when dependencies are missing. Flows may cause external effects; retrying an uncertain outcome can repeat them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payload` | object | No | Optional dynamic facts to persist before executing the asset. |
| `asset_slug` | string | Yes | Slug of the rule or flow bound to the context. |
| `asset_type` | string ("rule" | "flow") | Yes | Type of context-bound asset to execute. |
| `instance_id` | string | Yes | Context instance identity. |
| `context_slug` | string | Yes | Context slug. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit Context Data

**Slug:** `RULEBRICKS_SUBMIT_CONTEXT_DATA`

Merge facts into one Rulebricks context instance. This may immediately execute bound rules or flows and cause their external effects; returns the resolved state and triggered evaluations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include` | string | No | Comma-separated response fields to include. |
| `payload` | object | Yes | Dynamic facts matching the context schema to merge into the instance. |
| `instance_id` | string | Yes | Context instance identity. |
| `context_slug` | string | Yes | Context slug. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sync Value Collection

**Slug:** `RULEBRICKS_SYNC_VALUES`

Synchronize one vocabulary collection to a desired set. Chunks commit independently and must run sequentially under one fresh sync_id; finalize only after every chunk succeeds and do not overlap collection pipelines. Completion archives or deletes omitted members. This action always writes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `values` | object | No | Desired members keyed relative to the collection. Omit only when finalizing an existing chunked run. |
| `sync_id` | string | No | Run identifier for sequential chunk uploads. Omit for a single-request synchronization. |
| `complete` | boolean | No | Whether this is the final chunk and Rulebricks should sweep omitted members. Omission completes single-request syncs and leaves chunked runs open. |
| `metadata` | object | No | Custom metadata keyed by full value name, including the collection prefix. |
| `collection` | string | Yes | Collection path to synchronize; only values beneath this path are affected. |
| `user_groups` | array | No | User-group names to assign to values written by this call. |
| `permanently_delete` | boolean | No | Whether omitted values should be marked deleted instead of archived. Requires the delete-values entitlement. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Context

**Slug:** `RULEBRICKS_UPDATE_CONTEXT`

Update a Rulebricks context's name, schema, identity, retention, execution behavior, folder, or access groups. Changing identity_fact on a context with live instances changes how future writes resolve them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New context name; changing it regenerates the slug. |
| `folder` | string | No | Context folder ID. Pass null explicitly to remove the current folder. |
| `schema` | object | No | Replacement stored and derived field definitions. |
| `context_id` | string | Yes | Unique identifier of the context to update. |
| `description` | string | No | New context description. |
| `ttl_seconds` | integer | No | Instance time-to-live in seconds. |
| `user_groups` | array | No | User groups allowed to access the context. |
| `history_limit` | integer | No | Maximum history entries retained per field. |
| `identity_fact` | string | No | Key from schema.base that uniquely identifies instances. Changing it on a context with live instances changes how future writes resolve them. |
| `source_objects` | array | No | Workspace object IDs associated with the schema. |
| `on_schema_mismatch` | string ("ignore" | "reject" | "store") | No | Handling for submitted fields outside the schema. |
| `auto_execute_decisions` | boolean | No | Whether ready bound rules and flows execute automatically. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Folder

**Slug:** `RULEBRICKS_UPDATE_FOLDER`

Update an existing folder's required name and optional description by ID without changing its asset type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Updated folder name. |
| `folder_id` | string | Yes | ID of the folder to update. |
| `description` | string | No | Updated folder description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Manifest Part

**Slug:** `RULEBRICKS_UPLOAD_MANIFEST_PART`

Upload one plain UTF-8 or gzip-compressed part of a Rulebricks manifest larger than 4 MiB. Reuse one upload_id, send parts in zero-based order, then pass that ID and the total part count as manifest_upload to IMPORT_MANIFEST. Parts expire after 24 hours.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `part` | integer | Yes | Zero-based part index, from 0 through 4095. |
| `content` | string | No | One UTF-8 slice of serialized manifest JSON, at most 4 MiB. Split only between characters so concatenating every part recreates the manifest. |
| `upload_id` | string | Yes | Client-generated UUID reused for every part and the import reference. |
| `compressed_content` | object | No | One gzip-compressed manifest part. Use instead of content; decompressed UTF-8 bytes must be at most 4 MiB. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Object

**Slug:** `RULEBRICKS_UPSERT_OBJECT`

Create a workspace object by name or update one by ID or name, then synchronize values generated from its JSON Schema enums. Generated values removed from the submitted schema are archived. This action always writes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Object ID to update. |
| `name` | string | No | Object name; required when id is omitted. |
| `content` | string | Yes | JSON Schema object or serialized JSON string; enums become managed values. |
| `user_groups` | array | No | User groups applied to the object and its generated values. |
| `field_rename` | object | No | One field rename that preserves generated value IDs. |
| `expected_updated_at` | string | No | Reject the update if the object's updated_at timestamp has changed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create or Update Values

**Slug:** `RULEBRICKS_UPSERT_VALUES`

Create new vocabulary values or update existing values by name, including nested values and per-value metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `values` | object | Yes | Vocabulary values to create or update. Nested objects are flattened into dot-separated value names. |
| `metadata` | object | No | Custom metadata keyed by vocabulary value name. Empty or omitted entries preserve existing metadata. |
| `user_groups` | array | No | User-group names or IDs to assign to the written values. If omitted, Rulebricks applies the connected user's groups. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
