Integracje alarmów

Łączy obiekt z szablonem partnera monitorującego i zarządza tym połączeniem: zapisywanie (szablon, numer konta, mapa stref, zdarzenia, pola obiektu), usuwanie, prośba o zatwierdzenie, wysłanie sygnału testowego, aktywacja po udanym teście i odrzucenie przygotowanej zmiany.

Aktywne połączenie (active lub failing) zmienia się tylko z applyMode: staged pozostawia alarmy na bieżących ustawieniach, dopóki test przygotowanej zmiany się nie powiedzie i jej nie aktywujesz; immediate stosuje zmianę od razu. Pola tajne są akceptowane, ale nigdy nie są zwracane. Wymaga uprawnienia External Integrations w obiekcie. Najpierw odczytaj dane za pomocą alarm_integrations_read connections.

Akcje:

• save: Zapisanie połączenia. Nowe połączenie wymaga templateId. fields ustawia pola obiektu według klucza (null czyści pole; wartości tajne są zabezpieczane). W przypadku aktywnego połączenia przekaż applyMode, w przeciwnym razie wywołanie kończy się błędem apply-mode-required. Wymaga: partnerId. Prosi o potwierdzenie.
• remove: Usunięcie połączenia. Usuwa połączenie obiektu z partnerem wraz z ewentualną przygotowaną zmianą; alarmy z tego obiektu przestają trafiać do tego centrum monitorowania. Wymaga: partnerId. Prosi o potwierdzenie.
• request_approval: Prośba o zatwierdzenie. Prosi centrum monitorowania o zatwierdzenie połączenia lub przydzielenie numeru konta (szablony wymagające zatwierdzenia przez partnera). Wymaga: partnerId.
• send_test_signal: Wysłanie sygnału testowego. Kolejkuje prawdziwy sygnał testowy do centrum monitorowania; sprawdzaj test_signal_status. staged: true testuje przygotowaną zmianę zamiast bieżących ustawień. Wymaga: partnerId. Prosi o potwierdzenie.
• activate: Aktywacja połączenia lub zmiany. Uruchamia oczekujące połączenie, wdraża przygotowaną zmianę lub potwierdza nieprzetestowaną. Aktywacja wymaga requestId testu, który powiódł się po ostatniej zmianie: test przygotowanej zmiany (staged: true) wdraża przygotowaną zmianę, a test bieżących ustawień potwierdza nieprzetestowaną. Wymaga: partnerId, requestId. Prosi o potwierdzenie.
• discard_pending_change: Odrzucenie przygotowanej zmiany. Usuwa przygotowaną zmianę; bieżące ustawienia pozostają nienaruszone. discarded ma wartość false, gdy nic nie było przygotowane. Wymaga: partnerId. Prosi o potwierdzenie.

Dodaje, zmienia, usuwa i testowo uruchamia niestandardowe miejsca docelowe alarmów: własny odbiornik monitorujący, płytkę przekaźników, SMS, połączenia głosowe, e-mail, webhooki, czat zespołowy lub usługę powiadamiania dyżurnych (lista kanałów) na poziomie obiektu (domyślnie), marki lub organizacji.

Ustawienia niebędące tajnymi trafiają do config; wartości tajne (hasła, adresy URL webhooków, klucze) trafiają do fields według ścieżki ustawienia i są zabezpieczane, nigdy niezwracane. Włączone miejsca docelowe wymagają pełnej konfiguracji config. Miejsca docelowe obiektu wymagają tam uprawnienia External Integrations lub Duress Configuration; miejsca docelowe marki i organizacji wymagają dostępu na poziomie całej organizacji. Najpierw odczytaj dane za pomocą alarm_integrations_read destinations.

Akcje:

• save: Zapisanie miejsca docelowego. Bez connectionId dodaje nowe (wymagane channel i name); z nim zmienia istniejące (kanał pozostaje bez zmian). Przesłane config zastępuje ustawienia niebędące tajnymi; wartości tajne pominięte w fields są zachowywane. Prosi o potwierdzenie.
• remove: Usunięcie miejsca docelowego. Usuwa miejsce docelowe; przekaźnik obiektu przestaje też sterować przekaźnikiem alarmowym. Wymaga: connectionId. Prosi o potwierdzenie.
• send_test_signal: Wysłanie testu do miejsca docelowego. Kolejkuje prawdziwą wiadomość testową do miejsca docelowego; sprawdzaj alarm_integrations_read test_signal_status dla obiektu. Miejsca docelowe marki i organizacji są testowane z facilityId. Wymaga: connectionId. Prosi o potwierdzenie.

Odczytuje, dokąd poza Performance Hub trafiają alarmy napadowe obiektu: jego połączenia z centrami monitorowania (partner, szablon, numer konta, mapa stref, stan, braki w gotowości, przygotowane zmiany), niestandardowe miejsca docelowe (odbiorniki monitorujące, przekaźniki, SMS, połączenia głosowe, e-mail, webhooki, czat, powiadamianie dyżurnych) na poziomie obiektu, jego marki i organizacji, podgląd routingu, dziennik dostarczeń i wyniki sygnałów testowych.

Wymaga uprawnienia External Integrations lub Duress Configuration w obiekcie. Wartości tajne i zabezpieczone nigdy nie są pokazywane, tylko { key, secret, hasValue }; numery i adresy osób są ukrywane w routingu i dostarczeniach. Czas w formacie ISO. Zmiany wprowadzisz za pomocą alarm_integrations_connections_write i alarm_integrations_destinations_write.

Akcje:

• connections: Połączenia z centrami monitorowania. Połączenia obiektu z partnerami: szablon, numer konta (linkingIdentifier), mapa stref, zdarzenia, connectionStatus, missing (co blokuje uruchomienie), pendingChange (przygotowana, jeszcze nieaktywna) i untestedChange. canEdit: uprawnienie External Integrations w tym obiekcie.
• destinations: Niestandardowe miejsca docelowe. Miejsca docelowe, które mogą zostać uruchomione dla obiektu (własne, jego marki i organizacji, każde z canEdit), lub z ownerScope — miejsca docelowe jednego zakresu. Ustawienia w config; wartości tajne jako fields { key, secret, hasValue }.
• routing: Podgląd routingu. Dokąd alarm trafiłby w tej chwili (tylko bieżące ustawienia), tak jak rozwiązuje to universal-api: miejsca docelowe z lane, events i config bez wartości tajnych, problems wyjaśniające wszystko, co zostało pominięte, oraz pendingChanges jeszcze nieuwzględnione w routingu. eventType zostawia tylko to, co otrzymuje dane zdarzenie.
• deliveries: Dziennik dostarczeń. Dostarczenia alarmów od najnowszych (stan, kanał, odbiorca, opóźnienie, publiczny opis błędu). Przefiltrowana strona może być krótka i nadal mieć nextCursor. Alerty urządzeń są widoczne jako kind alert.
• test_signal_status: Wynik sygnału testowego. queued, dopóki universal-api nie zarejestruje próby, a następnie succeeded (odbiornik potwierdził lub wiadomość została wysłana) albo failed, wraz z wierszami dostarczeń. Użyj obiektu, z którego wysłano test. Wymaga: requestId.