מדריך ה‑API של תקריות

קבלת כל התקריות של הדף

נקודת קצה:

GET /v1/:page_id/incidents?page=:page&per_page=:per_page

• מספר העמוד שמוגדר כברירת מחדל הוא 1.
• ערך ברירת המחדל של per_page הוא 50, והמקסימום הוא 100 פריטים לעמוד.

דוגמת תשובה:

[
  {
    "id": "ckf01m59ueaqb0a32wrljz1yd",
    "name": "Rocket is going down",
    "started": "2020-09-12T19:05:17.398Z",
    "status": "RESOLVED",
    "resolved": "2020-09-12T19:09:04.498Z",
    "updates": [
      {
        "id": "ckf01m5ioeaqi0a32jtv8ovp8",
        "message": "We are currently investigating this incident.",
        "messageHtml": "<p>We are currently investigating this incident.</p>",
        "status": "INVESTIGATING",
        "notify": true,
        "started": "2020-09-12T19:05:17.398Z",
        "ended": null,
        "duration": 228,
        "createdAt": "2020-09-12T19:08:50.160Z"
      },
      {
        "id": "ckf01mnk9eaui0a32mmhgq68g",
        "message": "This incident has been resolved.",
        "messageHtml": "<p>This incident has been resolved.</p>",
        "status": "RESOLVED",
        "notify": true,
        "started": "2020-09-12T19:09:04.498Z",
        "ended": null,
        "duration": null,
        "createdAt": "2020-09-12T19:09:13.545Z"
      }
    ],
    "components": [
      {
        "id": "ckf01fvnxywz50a35nh1qzssm",
        "name": "Website",
        "status": "PARTIALOUTAGE",
        "showUptime": true,
        "site": {
          "id": "ckf01fonve9i40a32oas5b0uw",
          "name": "Nasa",
          "subdomain": "nasa",
          "color": null,
          "logoUrl": null,
          "publicEmail": null
        },
        "customImpactPercentage": 40
      }
    ],
    "user": {
      "id": "ckf01g7m4eaqb0a32fl7jl1xx",
      "name": "Buzz Aldrin",
      "email": "buzz@nasa.com"
    }
  }
]

אפשר להוסיף את פרמטרי השאילתה status ו‑!status כדי לצמצם את התוצאות לתקריות שיש להן, או שאין להן (בהתאמה), אחד מהסטטוסים ברשימה המופרדת בפסיקים.

user הוא חבר סביבת העבודה שיצר את התקרית. הערך הוא null כשהתקרית נוצרה אוטומטית (על ידי ניטור, אינטגרציית צד שלישי או אימייל).

קבלת תקרית

נקודת קצה:

GET /v1/:page_id/incidents/:incident_id

דוגמת תשובה:

{
  "id": "ckf01m59ueaqb0a32wrljz1yd",
  "name": "Rocket is going down",
  "status": "RESOLVED",
  "started": "2020-09-12T19:05:17.398Z",
  "resolved": "2020-09-12T19:09:04.498Z",
  "updates": [
    {
      "id": "ckf01m5ioeaqi0a32jtv8ovp8",
      "message": "We are currently investigating this incident.",
      "messageHtml": "<p>We are currently investigating this incident.</p>",
      "status": "INVESTIGATING",
      "notify": true,
      "started": "2020-09-12T19:05:17.398Z",
      "ended": null,
      "duration": 228,
      "createdAt": "2020-09-12T19:08:50.160Z"
    },
    {
      "id": "ckf01mnk9eaui0a32mmhgq68g",
      "message": "This incident has been resolved.",
      "messageHtml": "<p>This incident has been resolved.</p>",
      "status": "RESOLVED",
      "notify": true,
      "started": "2020-09-12T19:09:04.498Z",
      "ended": null,
      "duration": null,
      "createdAt": "2020-09-12T19:09:13.545Z"
    }
  ],
  "components": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "name": "Website",
      "status": "MAJOROUTAGE",
      "showUptime": true,
      "site": {
        "id": "ckf01fonve9i40a32oas5b0uw",
        "name": "Nasa",
        "subdomain": "nasa",
        "color": null,
        "logoUrl": null,
        "publicEmail": null
      }
    }
  ],
  "user": {
    "id": "ckf01g7m4eaqb0a32fl7jl1xx",
    "name": "Buzz Aldrin",
    "email": "buzz@nasa.com"
  }
}

הוספת תקרית

נקודת קצה:

POST /v1/:page_id/incidents

דוגמת בקשה:

{
  "name": "Test incident",
  "message": "We're currently investigating an issue with the Website",
  "components": ["ckf01fvnxywz50a35nh1qzssm"],
  "started": "2020-09-12 05:38:47.998",
  "status": "INVESTIGATING",
  "notify": true,
  "statuses": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "status": "PARTIALOUTAGE",
      "customImpactPercentage": 40
    }
  ],
  "translations": {
    "name": {
      "fr": "Incident de test"
    },
    "message": {
      "fr": "Nous enquêtons actuellement sur un problème avec le site Web"
    }
  }
}

תקריות מתפרסמות בדף הסטטוס שלכם כברירת מחדל. אם ברצונכם ליצור תקרית שאינה מפורסמת, כללו את shouldPublish והגדירו אותו ל‑false.

דוגמת תשובה:

{
  "id": "ckf02l5m8z36j0a35qr9q1tq1",
  "name": "Test incident",
  "status": "INVESTIGATING",
  "started": "2020-09-12T03:38:47.998Z",
  "resolved": null,
  "updates": [],
  "components": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "name": "Website",
      "status": "OPERATIONAL",
      "showUptime": true,
      "site": {
        "id": "ckf01fonve9i40a32oas5b0uw",
        "name": "Nasa",
        "subdomain": "nasa",
        "color": null,
        "logoUrl": null,
        "publicEmail": null
      }
    }
  ],
  "translations": {
    "name": {
      "fr": "Incident de test"
    },
    "message": {
      "fr": "Nous enquêtons actuellement sur un problème avec le site Web"
    }
  }
}

הוספת תקרית באמצעות תבנית

נקודת קצה:

POST /v1/:page_id/incidents/:template

דוגמת תשובה:

{
  "id": "cl8hrdsdsasu441sv26yq",
  "name": "Investigating Template",
  "nameTranslationId": null,
  "notify": false,
  "status": "INVESTIGATING",
  "started": "2022-09-25T19:53:20.778Z",
  "resolved": null,
  "duration": null,
  "createdAt": "2022-09-25T19:53:20.800Z",
  "updatedAt": "2022-09-25T19:53:20.800Z",
  "automated": false,
  "impact": "MAJOROUTAGE",
  "appId": null,
  "siteId": "cl8hadasdasd6wkxdco",
  "importedFrom": null
}

עדכון תקרית

נקודת קצה:

PUT /v1/:page_id/incidents/:incident_id

דוגמת בקשה:

{
  "name": "Test incident 2",
  "components": ["ckf01fvnxywz50a35nh1qzssm"],
  "started": "2020-09-12 05:38:47.998",
  "status": "INVESTIGATING",
  "notify": true,
  "statuses": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "status": "OPERATIONAL"
    }
  ],
  "translations": {
    "name": {
      "fr": "Incident de test"
    },
    "message": {
      "fr": "Nous enquêtons actuellement sur un problème avec le site Web"
    }
  }
}

דוגמת תשובה:

{
  "id": "ckf02l5m8z36j0a35qr9q1tq1",
  "name": "Test incident 2",
  "status": "INVESTIGATING",
  "started": "2020-09-12T03:38:47.998Z",
  "resolved": null,
  "updates": [],
  "components": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "name": "Website",
      "status": "OPERATIONAL",
      "showUptime": true,
      "site": {
        "id": "ckf01fonve9i40a32oas5b0uw",
        "name": "Nasa",
        "subdomain": "nasa",
        "color": null,
        "logoUrl": null,
        "publicEmail": null
      }
    }
  ],
  "translations": {
    "name": {
      "fr": "Incident de test"
    },
    "message": {
      "fr": "Nous enquêtons actuellement sur un problème avec le site Web"
    }
  }
}

מחיקת תקרית

נקודת קצה:

DELETE /v1/:page_id/incidents/:incident_id

דוגמת תשובה:

{
  "id": "ckf02l5m8z36j0a35qr9q1tq1"
}

קבלת המגיבים לתקרית

מי הוזעק לתקרית דרך הכוננות, האם מישהו כבר אישר את קבלתה ומי מוביל אותה.

נקודת קצה:

GET /v1/:page_id/incidents/:incident_id/responders

דוגמת תשובה:

{
  "incidentId": "ckf02l5m8z36j0a35qr9q1tq1",
  "paged": true,
  "acknowledged": true,
  "lead": {
    "teamMemberId": "clh8nmaan72592bfokqjqd95s1",
    "name": "Sam Rivera",
    "email": "sam@example.com"
  },
  "pages": [
    {
      "teamMemberId": "clh8nmaan72592bfokqjqd95s1",
      "name": "Sam Rivera",
      "email": "sam@example.com",
      "pagedAt": "2026-11-01T12:01:00.000Z"
    }
  ],
  "responders": [
    {
      "teamMemberId": "clh8nmaan72592bfokqjqd95s1",
      "name": "Sam Rivera",
      "email": "sam@example.com",
      "status": "ACKNOWLEDGED",
      "acknowledgedAt": "2026-11-01T12:05:00.000Z",
      "declinedAt": null
    }
  ]
}

אישור קבלת תקרית

אישור קבלת תקרית בשם המשתמש של מפתח ה‑API. האישור הראשון מבטל כל הסלמה שעדיין ממתינה להזעיק אנשים נוספים, והופך את האדם הזה למוביל התקרית אם אין לה מוביל. שום דבר לא משתנה בדף הסטטוס. אפשר לאשר שוב בבטחה: במקרה כזה alreadyAcknowledged הוא true.

נקודת קצה:

POST /v1/:page_id/incidents/:incident_id/acknowledge

דוגמת תשובה:

{
  "incidentId": "ckf02l5m8z36j0a35qr9q1tq1",
  "alreadyAcknowledged": false,
  "paged": true,
  "acknowledged": true,
  "lead": {
    "teamMemberId": "clh8nmaan72592bfokqjqd95s1",
    "name": "Sam Rivera",
    "email": "sam@example.com"
  },
  "pages": [
    {
      "teamMemberId": "clh8nmaan72592bfokqjqd95s1",
      "name": "Sam Rivera",
      "email": "sam@example.com",
      "pagedAt": "2026-11-01T12:01:00.000Z"
    }
  ],
  "responders": [
    {
      "teamMemberId": "clh8nmaan72592bfokqjqd95s1",
      "name": "Sam Rivera",
      "email": "sam@example.com",
      "status": "ACKNOWLEDGED",
      "acknowledgedAt": "2026-11-01T12:05:00.000Z",
      "declinedAt": null
    }
  ]
}