Skip to main content

Classification events (classification.*)

Customer categories (e.g. good payer, recurring late payer) that drive the collection rules. In entity events, data is the full classification with usage counters (_count).

classification.created​

{
  "event": "classification.created",
  "timestamp": "2026-07-23T12:00:00.000Z",
  "organization_id": "0f7a3c1e-2b4d-4e6f-8a9b-1c2d3e4f5a6b",
  "workspace_id": "5e8d1c4b-7a2f-4c9e-b3d6-0a1f2e3d4c5b",
  "data": {
    "id": "5d8e2f4a-6b1c-4d3e-9f7a-8c5b2d4e6f1a",
    "public_id": "d0e1f2a3-b4c5-4d6e-7f80-910213243546",
    "organization_id": "0f7a3c1e-2b4d-4e6f-8a9b-1c2d3e4f5a6b",
    "workspace_id": "5e8d1c4b-7a2f-4c9e-b3d6-0a1f2e3d4c5b",
    "company_id": null,
    "business_unit_id": null,
    "name": "Bom pagador",
    "code": "good_payer",
    "description": "Paga em dia na maioria dos ciclos",
    "color": "#22c55e",
    "priority": 1,
    "is_default": false,
    "auto_assign": true,
    "criteria": {
      "on_time_percentage_min": 80,
      "max_consecutive_delays": 1
    },
    "activated_at": "2026-07-23T12:00:00.000Z",
    "external_id": null,
    "custom_data": null,
    "tags": [],
    "deleted_at": null,
    "metadata": {},
    "custom_metadata": null,
    "created_at": "2026-07-23T12:00:00.000Z",
    "updated_at": "2026-07-23T12:00:00.000Z",
    "_count": { "people": 0, "collection_rules": 0 }
  }
}

classification.updated​

Fires when the classification is changed. Same shape as classification.created (with _count updated).

classification.deleted​

Fires on (logical) deletion; blocked while there are customers or collection rules linked — in those cases the event does not occur.

{
  "event": "classification.deleted",
  "timestamp": "2026-07-23T12:00:00.000Z",
  "organization_id": "0f7a3c1e-2b4d-4e6f-8a9b-1c2d3e4f5a6b",
  "workspace_id": "5e8d1c4b-7a2f-4c9e-b3d6-0a1f2e3d4c5b",
  "data": { "id": "5d8e2f4a-6b1c-4d3e-9f7a-8c5b2d4e6f1a" }
}

To know when a customer changes classification, subscribe to person.classification_changed.