Integrations לאזעקות

פלטפורמת הליבה

alarm_integrations_connections_writeIntegrations חיצוניות

מחבר מתקן לתבנית של שותף ניטור ומנהל את החיבור הזה: שמירה (תבנית, מספר חשבון, מפת אזורים, אירועים, שדות מתקן), הסרה, בקשת אישור, שליחת אות בדיקה, הפעלה לאחר בדיקה מוצלחת וביטול שינוי ממתין.

חיבור פעיל (active או failing) משתנה רק עם applyMode: staged משאיר את האזעקות על ההגדרות הפעילות עד שבדיקה של השינוי הממתין מצליחה ואתם מפעילים אותו; immediate מחיל את השינוי מיד. שדות סודיים מתקבלים אך לעולם אינם מוחזרים. דורש External Integrations במתקן. קראו תחילה באמצעות alarm_integrations_read connections.

פעולות:

save: שמירת חיבור. templateId נדרש עבור חיבור חדש. fields מגדיר שדות מתקן לפי מפתח (null מנקה שדה; סודות נחתמים). בחיבור פעיל העבירו applyMode, אחרת הקריאה נכשלת עם apply-mode-required. דורש partnerId. מבקש אישור.
remove: הסרת חיבור. מסיר את החיבור של המתקן לשותף, כולל כל שינוי ממתין; אזעקות מכאן מפסיקות להישלח למוקד הניטור הזה. דורש partnerId. מבקש אישור.
request_approval: בקשת אישור. מבקש ממוקד הניטור לאשר את החיבור או להקצות מספר חשבון (תבניות עם אישור שותף). דורש partnerId.
send_test_signal: שליחת אות בדיקה. מכניס לתור אות בדיקה אמיתי למוקד הניטור; בדקו את test_signal_status. staged: true בודק את השינוי הממתין במקום את ההגדרות הפעילות. דורש partnerId. מבקש אישור.
activate: הפעלת חיבור או שינוי. הופך חיבור ממתין לפעיל, מקדם שינוי ממתין או מאשר שינוי שלא נבדק. ההפעלה דורשת requestId של בדיקה שהצליחה לאחר השינוי האחרון: בדיקה של השינוי הממתין (staged: true) מקדמת שינוי ממתין, ובדיקה פעילה מאשרת שינוי שלא נבדק. דורש partnerId, requestId. מבקש אישור.
discard_pending_change: ביטול שינוי ממתין. מבטל את השינוי הממתין; ההגדרות הפעילות אינן משתנות. discarded הוא false כשלא היה שינוי ממתין. דורש partnerId. מבקש אישור.

פרמטרים

שם	סוג	תיאור
`action`*	`"save" \| "remove" \| "request_approval" \| "send_test_signal" \| "activate" \| "discard_pending_change"`	מה לעשות; כל פעולה מתוארת בתיאור הכלי.
`facilityId`	`string`	מזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
`partnerId`	`string`	שותף הניטור, מתוך alarm_integrations_read connections (org#<id> עבור התבניות של הארגון עצמו)
`templateId`	`string`	תבנית שפורסמה ומוצעת למתקן זה (save)
`linkingIdentifier`	`stringnull`	מספר החשבון שלפיו מוקד הניטור מזהה את המתקן (save)
`zoneMap`	`objectnull`	מספר סידורי של לחצן לאזור, לדוגמה { "DS-0001": "001" } (save)
`events`	`arraynull`	סוגי האירועים שנשלחים לשותף (null: אלה של התבנית) (save)
`fields`	`object`	ערכי שדות המתקן לפי מפתח; null מנקה שדה. לעולם אינם מוחזרים. (save)
`applyMode`	`"staged" \| "immediate"`	חיבורים פעילים: staged (בדיקה ואז הפעלה) או immediate (save)
`staged`	`boolean`	בדיקת השינוי הממתין (נדרשת לפני הפעלתו) (send_test_signal)
`requestId`	`string`	מזהה בקשה של אות בדיקה (tsr_...), מתוך send_test_signal (activate)
`confirm`	`boolean`	הגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה

alarm_integrations_destinations_writeIntegrations חיצוניותDuress Configuration

מוסיף, משנה, מוחק ושולח בדיקה ליעדי אזעקה מותאמים אישית: מקלט ניטור משלכם, לוח ממסרים, SMS, שיחה קולית, דוא"ל, webhooks, צ'אט צוות או שירות זימון כוננים (רשימת הערוצים), ברמת מתקן (ברירת מחדל), מותג או ארגון.

הגדרות שאינן סודיות נכנסות ל-config; סודות (סיסמאות, כתובות URL של webhook, מפתחות) נכנסים ל-fields לפי נתיב ההגדרה ונחתמים, ולעולם אינם מוחזרים. יעדים מופעלים דורשים config מלא. יעדי מתקן דורשים External Integrations או Duress Configuration באותו מתקן; יעדי מותג וארגון דורשים גישה ברמת הארגון. קראו תחילה באמצעות alarm_integrations_read destinations.

פעולות:

save: שמירת יעד. בלי connectionId מוסיף יעד (נדרשים channel ו-name); עם connectionId משנה יעד (הערוץ נשאר). כאשר config נשלח, הוא מחליף את ההגדרות שאינן סודיות; סודות שלא נכללו ב-fields נשמרים. מבקש אישור.
remove: מחיקת יעד. מוחק את היעד; ממסר של מתקן גם מפסיק להפעיל את ממסר האזעקה. דורש connectionId. מבקש אישור.
send_test_signal: שליחת בדיקה ליעד. מכניס לתור הודעת בדיקה אמיתית ליעד; בדקו את alarm_integrations_read test_signal_status עם המתקן. יעדי מותג וארגון נבדקים מ-facilityId. דורש connectionId. מבקש אישור.

פרמטרים

שם	סוג	תיאור
`action`*	`"save" \| "remove" \| "send_test_signal"`	מה לעשות; כל פעולה מתוארת בתיאור הכלי.
`facilityId`	`string`	מזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
`ownerScope`	`string`	facility#<id>, brand#<id> או org#<id> (ברירת מחדל: המתקן)
`connectionId`	`string`	היעד לשינוי; השמיטו כדי להוסיף יעד
`channel`	`"cid-csvip" \| "sentinel-http" \| "relay" \| "sms" \| "voice" \| "email" \| "webhook" \| "slack" \| "teams" \| "google-chat" \| "pagerduty" \| "opsgenie"`	סוג היעד; לא ניתן לשנותו לאחר היצירה (save)
`name`	`string`	מוצג בהגדרות וביומן המסירה (save)
`enabled`	`boolean`	ברירת מחדל true עבור יעדים חדשים (save)
`events`	`arraynull`	סוגי האירועים שהיעד מקבל (null: ברירות המחדל של הערוץ) (save)
`guestLink`	`"shared" \| "none" \| "null"`	לערוצי SMS, דוא"ל וצ'אט צוות בלבד: shared (דף אזעקה אחד לצפייה בלבד, ברירת המחדל) או none (save)
`config`	`object`	הגדרות שאינן סודיות עבור הערוץ (save)
`fields`	`object`	הגדרות סודיות לפי נתיב, לדוגמה { "webhookUrl": "https://..." }; null מנקה הגדרה (save)
`confirm`	`boolean`	הגדירו רק לאחר שהמשתמש אישר את התצוגה המקדימה שהוחזרה בקריאה הראשונה

alarm_integrations_readIntegrations חיצוניותDuress Configuration

קורא לאן נשלחות אזעקות ה-Duress של מתקן מחוץ ל-Performance Hub: חיבורי מוקד הניטור שלו (שותף, תבנית, מספר חשבון, מפת אזורים, סטטוס, פערי מוכנות, שינויים ממתינים), יעדים מותאמים אישית (מקלטי ניטור, ממסרים, SMS, שיחה קולית, דוא"ל, webhooks, צ'אט, זימון) ברמת המתקן, המותג שלו והארגון, תצוגה מקדימה של הניתוב, יומן המסירה ותוצאות אותות הבדיקה.

דורש External Integrations או Duress Configuration במתקן. סודות וערכים חתומים לעולם אינם מוצגים, אלא רק { key, secret, hasValue }; מספרי טלפון וכתובות של אנשים מושחרים בניתוב ובמסירות. השעות בפורמט ISO. שנו אותם באמצעות alarm_integrations_connections_write ו-alarm_integrations_destinations_write.

פעולות:

connections: חיבורי מוקד ניטור. חיבורי השותפים של המתקן: תבנית, מספר חשבון (linkingIdentifier), מפת אזורים, אירועים, connectionStatus, missing (מה מונע מעבר לפעילות), pendingChange (שינוי ממתין שעדיין אינו פעיל) ו-untestedChange. canEdit: External Integrations במתקן זה.
destinations: יעדים מותאמים אישית. יעדים שיכולים להיות מופעלים עבור המתקן (שלו, של המותג שלו ושל הארגון, כל אחד עם canEdit), או עם ownerScope היעדים של היקף אחד. ההגדרות ב-config; סודות כ-fields { key, secret, hasValue }.
routing: תצוגה מקדימה של הניתוב. לאן אזעקה הייתה נשלחת כרגע (הגדרות פעילות בלבד), כפי ש-universal-api מפענח זאת: יעדים עם lane, אירועים ו-config ללא סודות, בעיות שמסבירות כל מה שהושמט, ו-pendingChanges שעדיין אינם מנותבים. eventType משאיר רק את מה שמקבל את האירוע הזה.
deliveries: יומן מסירה. מסירות אזעקה מהחדשה לישנה (סטטוס, ערוץ, מקלט, השהיה, נוסח השגיאה הציבורי). עמוד מסונן יכול להיות קצר ועדיין לכלול nextCursor. התראות מכשירים מוצגות כ-kind alert.
test_signal_status: תוצאת אות הבדיקה. queued עד ש-universal-api רושם ניסיון, ואז succeeded (מקלט אישר קבלה או שהאות נשלח) או failed, עם שורות המסירה. השתמשו במתקן שממנו נשלחה הבדיקה. דורש requestId.

פרמטרים

שם	סוג	תיאור
`action`*	`"connections" \| "destinations" \| "routing" \| "deliveries" \| "test_signal_status"`	מה לעשות; כל פעולה מתוארת בתיאור הכלי.
`facilityId`	`string`	מזהה המתקן. אופציונלי כשהמתקן המחובר הוא המתקן שאליו אתם מתכוונים.
`limit`	`integer`	פריטים בעמוד (ברירת מחדל 25, לכל היותר 100) (connections, destinations, deliveries)
`cursor`	`string`	nextCursor מהעמוד הקודם (connections, destinations, deliveries)
`ownerScope`	`string`	רק ההיקף הזה: brand#<id> או org#<id> (destinations)
`eventType`	`string`	לדוגמה ph.duress.incident.created (routing, deliveries)
`from`	`string`	תאריך ושעה בפורמט ISO, כולל (deliveries)
`to`	`string`	תאריך ושעה בפורמט ISO, לא כולל (deliveries)
`status`	`array`	כל אחד מהערכים sent, acknowledged, failed, shadow (deliveries)
`channel`	`string`	ערוץ מדויק, לדוגמה cid-csvip או sms (deliveries)
`destinationId`	`string`	מזהה יעד מדויק (deliveries)
`incidentId`	`string`	מסירות של אזעקה אחת (deliveries)
`requestId`	`string`	מסירות של אות בדיקה אחד (deliveries, test_signal_status)
`search`	`string`	טקסט בכל מזהה, ערוץ או שגיאה (deliveries)