All articles 8 / 8

Jak konfigurować alerty watchlisty

Endpoint PATCH /api/v1/watchlist/alerts steruje tym, kiedy i w jaki sposób otrzymujesz powiadomienia o zmianach wykrytych w company monitor. Możesz skonfigurować jedną globalną politykę dla wszystkich monitorowanych firm lub dostroić ustawienia per firma.

Zanim zaczniesz — domyślne ustawienia

Alerty są domyślnie wyłączone dla każdego wpisu na watchliście. Musisz je jawnie aktywować. Ustawienia per firma zawsze mają pierwszeństwo nad konfiguracją globalną.

Domyślnie wyłączone alerts_enabled jest false dla każdego nowego wpisu. Przekaż true, żeby aktywować.

Tryb globalny Pomiń identifier_type i identifier_value — dotyczy wszystkich wpisów bez indywidualnych ustawień.

Tryb per firma Przekaż identifier_type + identifier_value dla jednej firmy. Ustawia has_custom_settings: true.

Konfiguracja globalna

Pomiń zarówno identifier_type jak i identifier_value. Ustawienia dotyczą wszystkich wpisów na watchliście, które nie mają własnych ustawień. W poniższym przykładzie każdy event na poziomie warning lub wyższym wyzwala powiadomienie email.

            
Request — globalny

PATCH /api/v1/watchlist/alerts

curl -X PATCH "https://api.alexambros.com/api/v1/watchlist/alerts" \
  -H "Authorization: Bearer sk_api_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "alert_min_severity": "warning",
    "alerts_enabled":     true,
    "notify_via_email":   true
  }'

            
Response · 200 OK

{
  "success": true,
  "data": { "updated": 42 }
}

Globalny z force — nadpisanie wszystkich

Dodanie force: true nadpisuje nawet firmy posiadające indywidualne ustawienia per firma. Resetuje też has_custom_settings do false dla każdego wpisu. Użyj, gdy chcesz wymusić jednolitą politykę na całej watchliście.

            
Request — globalny + force

PATCH /api/v1/watchlist/alerts

  -d '{
    "alert_min_severity": "warning",
    "alerts_enabled":     true,
    "notify_via_email":   true,
    "force":             true
  }'

Konfiguracja per firma

Przekaż identifier_type i identifier_value, żeby wskazać konkretną firmę. Ustawia has_custom_settings: true dla tego wpisu — firma nie będzie już objęta przyszłymi aktualizacjami globalnymi chyba że użyjesz force: true. W przykładzie poniżej powiadomienie wyzwalają tylko eventy klasy risk i anomaly w kategoriach finance lub status na poziomie high lub wyższym.

            
            
            
        
Request — per firma

PATCH /api/v1/watchlist/alerts

  -d '{
    "alert_min_severity":  "high",
    "alerts_enabled":      true,
    "notify_via_email":    true,
    "alert_event_classes": ["risk", "anomaly"],
    "alert_categories":    ["finance", "status"],
    "identifier_type":     "NIP",
    "identifier_value":    "6842685591"
  }'
    

Tabela parametrów

Wszystkie parametry są przekazywane jako body JSON. Tylko alert_min_severity jest wymagany.

Parametr	Typ	Opis
`alert_min_severity` *	enum	Wymagany. Minimalny poziom ważności eventu który wyzwala alert. Dostępne: `info`, `notice`, `warning`, `high`, `error`, `critical`.
`alerts_enabled`	boolean	Włącz lub wyłącz alerty. Gdy pominięte, aktualna wartość jest zachowana. Domyślnie wyłączone.
`notify_via_email`	boolean	Włącz powiadomienia email. Domyślnie wyłączone.
`alert_event_classes`	array	Ogranicz alerty do wybranych klas eventów. Dostępne: `initialization`, `change`, `growth`, `risk`, `anomaly`, `recovery`. Pomiń, żeby otrzymywać wszystkie klasy.
`alert_categories`	array	Ogranicz alerty do wybranych kategorii danych. Dostępne: `status`, `identity`, `location`, `ownership`, `activities`, `contacts`, `web_presence`, `finance`. Pomiń, żeby otrzymywać wszystkie.
`force`	boolean	Gdy `true`, nadpisuje ustawienia per firma i resetuje `has_custom_settings` do `false` dla wszystkich wpisów. Ignorowane w trybie per firma.
`identifier_type`	enum	Typ identyfikatora przy targetowaniu per firma: `NIP`, `REGON9`, `KRS`. Wymagany razem z `identifier_value`.
`identifier_value`	string	Wartość identyfikatora docelowej firmy. Wymagana razem z `identifier_type`. Maks. 50 znaków.

Priorytety ustawień

Gdy wykryta zostaje zmiana, system rozstrzyga które ustawienia alertów zastosować w następującej kolejności:

Ustawienia per firma (has_custom_settings: true) — zawsze stosowane w pierwszej kolejności.
Ustawienia globalne — stosowane dla pozostałych wpisów.
Domyślne (wyłączone) — jeśli dla wpisu nie skonfigurowano żadnych ustawień.

← Previous 4. Jak używać Company Monitor?