Skip to main content
GET
Get the rules-of-engagement catalog
The vocabulary for writing rules of engagement. Read it before you create or change a policy: every condition, action, outcome and parameter you send is checked against it.

How to use it

  1. Pick a scope from scopes, such as enrollment or email_step.
  2. Pick conditions from conditions whose scopes include it, and fill their params as each parameter spec describes.
  3. Pick an action from actions whose scopes include it.
  4. For reactions, pick an outcome from outcomes and one or more actions from outcome_actions.

Good to know

  • A parameter with options accepts only those values. One with options_source takes team-specific values (your CRMs, sequences, call dispositions or reply labels) that the catalog does not list.
  • A condition marked deprecated still works in existing policies. Use its replacement in new rules: crm_record_field instead of crm_field.
  • A condition group nests at most limits.condition_depth levels and holds at most limits.condition_leaves conditions.
  • The catalog is the same for every team. See Rules of engagement for what each rule means in practice.

Authorizations

x-api-key
string
header
required

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.

scopes
object[]

Where a scenario can be checked: enrollment, step, email_step, call_step.

conditions
object[]

Condition types for scenarios.

actions
object[]

Scenario actions, each with the scopes it may run at.

outcomes
object[]

Outcomes a reaction can respond to.

outcome_actions
object[]

Actions a reaction can take.

crm_objects
object

The CRM objects a crm_record_field condition can read, per CRM.

operators
object[]

Comparisons a crm_record_field condition can use.

field_operators
object

Which operators a CRM field of each kind (text, number, date, boolean, enumeration) allows.

limits
object