Skip to main content
Reply rules are the API form of Automations > Reply Rules in the Fini dashboard. They decide how an agent responds when workspace-specific conditions match. The API currently supports read-only access. Use the configured rules endpoint to audit active behavior, and use fields context to resolve condition paths into customer-friendly labels and available values.

​
Endpoints

Get reply rules

Read the no reply, internal comment, and direct reply rule slots.

Get fields context

Read the fields, operators, sources, attributes, and tags available to conditions.

​
Authentication

​
string
required
Bearer token containing your Fini workspace API key. Format: Bearer fini_... The key needs read scope.
The workspace is derived from the API key. These endpoints do not accept a workspace ID.

​
Reply rule collection

The collection always contains three slots. A slot without a saved rule returns conditions: [] and isEnabled: false.
​
ReplyRule
Conditions under which the agent sends no customer-facing reply.
​
ReplyRule
Conditions under which the agent adds a note visible only to the support team.
​
ReplyRule
Conditions under which the agent sends a reply directly to the customer.

​
ReplyRule object

​
string
NO_REPLY, INTERNAL_COMMENT, or DIRECT_REPLY.
​
Condition[]
Condition groups evaluated for this behavior. An empty array means no rule is configured.
​
boolean
Whether Fini evaluates this rule.
​
string | undefined
Saved rule ID. Omitted for a default empty slot.
​
string | undefined
Workspace ID recorded on a saved rule. Omitted for a default empty slot.
​
string | undefined
ISO 8601 creation timestamp. Omitted for a default empty slot.
​
string | undefined
ISO 8601 last-update timestamp. Omitted for a default empty slot.

​
Condition object

​
string
SCALAR for predicates against individual values, or ARRAY for quantified array conditions.
​
array
Comparisons with left.path, left.dataType, operator, and a right.value or right.path.
​
string | undefined
ANY, ALL, or NONE for an array condition.
​
object | undefined
Array path and item type used by an array condition.

​
Errors

The API key is missing, malformed, revoked, or invalid.
The API key does not include the read scope.
Fini failed while loading reply rules or their fields context.