rules-tool
Create, list, update, delete automation rules and retrieve event trigger history to trigger notifications, recordings, or actions based on camera, sensor, and door events.
Instructions
This tool manages Rhombus automation rules for triggering actions based on events.
It has the following modes of operation, determined by the "requestType" parameter:
list: List all automation rules in the organization.
create: Create a new automation rule. Requires ruleName and ruleConfig (JSON string with the rule definition).
update: Update an existing rule. Requires ruleUuid and ruleConfig (JSON string with updated fields).
delete: Delete a rule. Requires ruleUuid.
get-records: Get the event trigger history for a specific rule. Requires ruleUuid.
Rules can trigger notifications, recordings, and other actions based on events from cameras, sensors, doors, etc.
Output filtering (all tools):
includeFields(string[]): Dot-notation paths to keep in the response (e.g."vehicleEvents.vehicleLicensePlate"). Omit to return all fields.filterBy(array): Predicates to filter array items. Each entry:{field, op, value}where op is one of= != > >= < <= contains. All conditions are ANDed. Example:[{field:"vehicleLicensePlate", op:"=", value:"ABC123"}]WARNING: some tool responses exceed 400k characters — use these params to request only the data you need.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| requestType | Yes | The type of rules operation to perform. | |
| ruleUuid | Yes | The UUID of the rule. Required for 'update', 'delete', and 'get-records'. | |
| ruleName | Yes | The name of the rule. Required for 'create'. | |
| ruleConfig | Yes | JSON string of the rule configuration. Required for 'create' and 'update'. Contains the rule definition. | |
| includeFields | Yes | Dot-notation field paths to include in the response (e.g. "vehicleEvents.vehicleLicensePlate"). Pass null to return all fields. WARNING: some responses can exceed 400k characters — use includeFields to request only the data you need. For high-volume tools this may be required to get a complete answer. | |
| filterBy | Yes | Filter array items in the response by field values. All conditions are ANDed. Example: [{field: "vehicleLicensePlate", op: "=", value: "ABC123"}, {field: "confidence", op: ">", value: 0.8}] Use alongside includeFields to get only the specific records and fields you need. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rules | No | List of rules | |
| rule | No | Result of create/update/delete operation | |
| ruleRecords | No | Rule trigger event records | |
| error | No | An error message if the request failed. |