Customizations of the CRM live in a file crm.yaml in your own git repository: buttons on cases and files (customActions), template variables filled from your systems (templateCustomVariables), your own case categories and states (categories), task kinds (taskVerbs) and person kinds (personKinds). We connect the repository with a read-only deploy key; a GitHub webhook pulls it after every push and validates the file. Set it up in Settings → Advanced → Your own repository. The connection is available after activation, write to us.

The JSON schema is at crm-schema.json; validate locally with yajsv -s crm-schema.json crm.yaml. An invalid file is reported in Settings and by e-mail; the last valid configuration stays in use only until the next pull, so fix it promptly.

Example

service:
  auth: a-shared-secret-of-your-choice
  url: https://crm.example.com/ispis   # only when the server runs on your side

customActions:
  - id: TransferToCollection
    title: Transfer to external collection
    domain: case            # case | file | person | claim | paid | txn
    type: Remote            # Remote = your back-end, Core = built-in action
  - id: StatementHTML
    title: Statement as HTML
    button: HTML
    domain: file
    limitFileType: statement
    type: Remote

templateCustomVariables:
  - id: Loan                # used as [% Loan %] in templates

categories:
  - id: Settlement
    title: Settlement
    default: true           # category of a new case (at most one)
    initialState: Received  # state of a new case
    states:                 # order of states = order in the list
      - id: Received
        desc: Received, waiting for analysis
        color: '#33B5E5'
        colorAlt: '#0099CC' # optional, a darker shade is derived
        substates: [YES, NO]
      - id: Negotiation
        desc: Proposal sent, waiting for the other party
        color: '#FFBB33'
      - id: Settled
        desc: Signed and paid
        color: '#666666'
        closed: true        # terminal state; at least one per category
      - id: Closed
        color: '#9E9E9E'
        closed: true
  - id: Inkaso              # a shared built-in category, referenced by id

taskVerbs:
  - { id: analyse, title: Analyse }
  - { id: refund, title: Refund }

personKinds: [client, representative, finarb]

service

The custom server that answers custom actions and template variables. Either we host it for you (leave url out) or it runs on your side (url). iSpis calls fixed endpoints under the base URL and sends Authorization: Bearer <service.auth> with every request:

What	Request
custom action on a case or person	GET <url>/customAction/<id>?refno=<RefNo>
custom action on a file	GET <url>/customAction/<id>?peId=<file id>
template variable	GET <url>/customVar?name=<id>&refno=<RefNo>

A custom action returns JSON; a download action returns { "name": "file.pdf", "base64": "..." }. A template variable returns JSON (a string or an object whose keys are used as [% Loan.Amount %]). Errors go to the x-ispis-error response header. An item may instead carry its own absolute url (legacy), then service is not needed and refno= / peId= is appended to it.

categories

Replaces the built-in categories of your account with your own. A category has an id (letters, digits, _), an optional title, default: true for the category of a new case, initialState for the state of a new case and a non-empty ordered list of states. An item with only an id refers to a shared built-in category (Inkaso, Advokat, Marketing, Loan, Collection, Attorney), so you can combine your own categories with ours.

A state has id, optional title and desc, color (#rrggbb), optional colorAlt (darker shade), optional substates and closed: true for a terminal state. Closed cases are excluded from active lists and from "not closed" exports; Close case switches to the first closed state (Closed, ExtClosed or Uzavřeno preferred), so give every category at least one. States already used by your cases must stay in the list, otherwise such cases show without a state badge.

taskVerbs, personKinds

• taskVerbs replaces the built-in task kinds; title is the English label (translated where we have a translation), default is the built-in label or the id.
• personKinds restricts the person kinds offered on a case to a selection of the built-in ones (client, representative, finarb, debtor, …).
• The system login (the user that authors automatic changes, for example a state change after a finished task) is set by us on activation.

Rules

• Custom data on a case or person is key → value (string). A structured value goes under a key with the suffix JSON, stored as a JSON string.
• config.yaml in the same repository belongs to the Loan module; once crm.yaml exists, CRM keys in config.yaml are ignored.
• Outgoing webhooks (case created, screening finished, inbox message) and further events are available after activation.

Source: src/core/crm/crm.docs.md