Każdy event generowany przez rejestr zawiera trzy pola metadanych: severity, event_class i category. Razem pozwalają precyzyjnie filtrować strumień eventów — odbierając tylko sygnały istotne dla Twojego przypadku użycia.
Severity — ważność
Severity określa wagę biznesową zmiany — jak pilnie wymaga reakcji. Jest przypisana statycznie do każdego typu eventu i nie zmienia się dynamicznie. Zdefiniowano sześć poziomów, od najmniej do najbardziej krytycznego.
| Poziom | Znaczenie | Przykładowe eventy |
|---|---|---|
info |
Neutralna zmiana informacyjna, nie wymaga działania. | Numer faksu dodany lub zmieniony. |
notice |
Drobna, ale warta odnotowania aktualizacja. | Telefon lub email dodany, kod PKD dodany, jednostka lokalna otwarta. |
warning |
Istotna zmiana — zalecany przegląd. | Zmiana nazwy, adresu, usunięcie PKD, zamknięcie jednostki. |
high |
Ważna zmiana strukturalna — wymagana szczególna uwaga. | Zmiana właściciela lub wspólników, zmiana formy prawnej, zakończenie upadłości, wznowienie działalności. |
error |
(zarezerwowany do przyszłego użycia) | — |
critical |
Zdarzenie krytyczne — natychmiastowa reakcja wymagana. | Zawieszenie firmy, wykreślenie z rejestru, ogłoszenie upadłości, zmiana NIP lub REGON. |
Klasa eventu — event_class
Klasa grupuje eventy według ich natury — jakiego rodzaju zmiana nastąpiła, niezależnie od tego, którego pola dotyczyła. Pozwala subskrybować wzorzec zachowania firmy zamiast poszczególnych typów eventów.
| Klasa | Znaczenie | Przykładowe eventy |
|---|---|---|
change |
Wartość została zmodyfikowana — coś się zmieniło. | Zmiana nazwy, adresu, telefonu, kodów PKD. |
risk |
Negatywne zdarzenie sugerujące potencjalne problemy. | Zawieszenie, zamknięcie firmy, zamknięcie jednostki, ogłoszenie upadłości. |
anomaly |
Niezwykła lub statystycznie nieprawdopodobna zmiana. | Zmiana NIP (COMPANY_TAX_IDENTITY_CHANGED), zmiana REGON (ANOMALY_REGON_CHANGE). |
growth |
Pozytywny sygnał wzrostu — coś zostało dodane. | Telefon, email, strona www dodana; kod PKD dodany; jednostka otwarta; adres dodany. |
recovery |
Powrót do normalnego stanu po zdarzeniu negatywnym. | Zakończenie upadłości, wznowienie działalności. |
initialization |
Nowy podmiot pojawił się w rejestrze po raz pierwszy. | (zarezerwowany do wykrywania nowych firm) |
Kategoria — category
Kategoria opisuje którą część profilu firmy dotyczy event. Pozwala ograniczyć alerty wyłącznie do interesujących Cię obszarów danych — np. tylko zmiany finansowe lub tylko zmiany kontaktowe.
| Kategoria | Znaczenie |
|---|---|
status | Status operacyjny — zawieszenia, zamknięcia, wznowienia, zmiany daty aktywacji. |
identity | Tożsamość prawna — nazwa, forma prawna, typ podmiotu, NIP, REGON. |
location | Adres i jednostki lokalne — adres rejestracji, oddziały. |
ownership | Struktura właścicielska — właściciel (JDG) lub wspólnicy. |
activities | Działalności gospodarcze — kody PKD dodane, usunięte lub zmienione. |
contacts | Dane kontaktowe — telefon, email, faks. |
web_presence | Obecność w sieci — adres strony www dodany, zmieniony lub usunięty. |
finance | Postępowania finansowe — rozpoczęcie i zakończenie upadłości. |
Jak pola wyglądają w odpowiedzi API
Pole severity jest zwracane w każdym obiekcie eventu we wszystkich endpointach — /watchlist/events, /companies/events i /events/feed. Pola event_class i category to metadane ze słownika typów eventów — użyj ich do konfiguracji filtrów alertów w PATCH /watchlist/alerts.
{
"event_type": "COMPANY_BANKRUPTCY_STARTED",
"old_value": null,
"new_value": "2026-04-10",
"event_date": "2026-04-11",
"severity": "critical",
}
Praktyczne zastosowanie
Trzy pola są zaprojektowane do łączenia. W PATCH /watchlist/alerts możesz ustawić alert_min_severity, alert_event_classes i alert_categories niezależnie — dając precyzyjną kontrolę nad tym, które eventy wyzwalają powiadomienie.