Overview - Fini

Business Rules are the workflows configured under Automations → Business Rules. They use their own /v2/business-rules/... public API routes, separate from the /v2/hc-rules/... routes used by intent rules. Business Rules are not versioned. They are stored and updated directly, and currently run for source: "widget" with triggerType: "on_escalation".

Business-rule endpoints

Method	Path	Scope	Business-rule usage
`GET`	`/v2/business-rules/public`	`read`	List Business Rules, with optional `source=widget`.
`GET`	`/v2/business-rules/fields-context/public`	`read`	Get fields available to Business Rule trees.
`GET`	`/v2/business-rules/default/public`	`read`	List Fini-provided Business Rule templates.
`GET`	`/v2/business-rules/:id/public`	`read`	Get one Business Rule with its full tree.
`POST`	`/v2/business-rules/public`	`write`	Create a custom or template-based Business Rule.
`POST`	`/v2/business-rules/:id/duplicate/public`	`write`	Duplicate a custom Business Rule.
`POST`	`/v2/business-rules/:id/evaluate/public`	`write`	Evaluate one Business Rule against supplied input context.
`GET`	`/v2/business-rules/:id/test-fields/public`	`read`	Return the test fields for one saved Business Rule.
`POST`	`/v2/business-rules/test-fields/preview/public`	`read`	Preview test fields for an unsaved Business Rule tree.
`PATCH`	`/v2/business-rules/:id/public`	`write`	Update the stored rule directly.
`DELETE`	`/v2/business-rules/:id/public`	`write`	Delete the rule and its agent assignments.

Custom and template-based rules

Mode	Create request
Custom	Send `source: "widget"`, `triggerType: "on_escalation"`, and a `flowConfig`.
Template-based	Send `defaultRuleId` or `defaultBusinessRuleId` from List default Business Rules. Do not send `flowConfig`. Use `inputSchema` to bind template inputs.

Business Rules cannot be drafts. Do not send status: "DRAFT", and do not call draft-generation, version, publish, or restore endpoints for them.

Business-rule response fields

Business Rule responses include id, companyId, name, description, source, triggerType, defaultRuleId, defaultBusinessRuleId, inputSchema, flowConfig, botIds, createdAt, and updatedAt. Intent Rule version fields do not apply.

​Business-rule endpoints

​Custom and template-based rules

​Business-rule response fields

Business-rule endpoints

Custom and template-based rules

Business-rule response fields