Get the rules-of-engagement catalog
Returns the vocabulary rules of engagement are built from: scopes, conditions, scenario actions, outcomes and reaction actions, with the scopes each is valid in and the parameters each takes.
Read it before writing a policy. Create and update validate against the same table, and a rule outside it is refused with 400. Each parameter is described by key, label, input, required, min, max and, for a closed list, options. Parameters whose values are team-specific (your CRMs, sequences, call dispositions, reply labels) name an options_source instead of listing options. A condition marked deprecated still works in existing policies but should not be used in new rules.
The catalog is the same for every team. Counts against the Sequencer reads rate limit.
How to use it
- Pick a scope from
scopes, such asenrollmentoremail_step. - Pick conditions from
conditionswhosescopesinclude it, and fill theirparamsas each parameter spec describes. - Pick an action from
actionswhosescopesinclude it. - For reactions, pick an outcome from
outcomesand one or more actions fromoutcome_actions.
Good to know
- A parameter with
optionsaccepts only those values. One withoptions_sourcetakes team-specific values (your CRMs, sequences, call dispositions or reply labels) that the catalog does not list. - A condition marked
deprecatedstill works in existing policies. Use its replacement in new rules:crm_record_fieldinstead ofcrm_field. - A condition group nests at most
limits.condition_depthlevels and holds at mostlimits.condition_leavesconditions. - The catalog is the same for every team. See Rules of engagement for what each rule means in practice.
Authorizations
Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.
Response
The catalog. Abbreviated in this example.
Where a scenario can be checked: enrollment, step, email_step, call_step.
Condition types for scenarios.
Scenario actions, each with the scopes it may run at.
Outcomes a reaction can respond to.
Actions a reaction can take.
The CRM objects a crm_record_field condition can read, per CRM.
Comparisons a crm_record_field condition can use.
Which operators a CRM field of each kind (text, number, date, boolean, enumeration) allows.