⌘ K

API-reference for hændelser

Hent alle sidens hændelser

Endpoint:

GET /v1/:page_id/incidents?page=:page&per_page=:per_page
  • Standardsidenummeret er 1.
  • Standardværdien for per_page er 50, og der er højst 100 elementer pr. side.

Eksempel på svar:

[
  {
    "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"
    }
  }
]

Du kan tilføje query-parametrene status og !status for at begrænse resultaterne til hændelser, der henholdsvis har eller ikke har en af statusserne i en kommasepareret liste.

user er det workspace-medlem, der oprettede hændelsen. Den er null, når hændelsen blev oprettet automatisk (af en monitor, en tredjepartsintegration eller en e-mail).

Hent en hændelse

Endpoint:

GET /v1/:page_id/incidents/:incident_id

Eksempel på svar:

{
  "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"
  }
}

Tilføj en hændelse

Endpoint:

POST /v1/:page_id/incidents

Eksempel på forespørgsel:

{
  "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"
    }
  }
}

Hændelser offentliggøres som standard på din statusside. Vil du oprette en hændelse, der ikke offentliggøres, skal du medsende shouldPublish og sætte den til false.

Eksempel på svar:

{
  "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"
    }
  }
}

Tilføj en hændelse med en skabelon

Endpoint:

POST /v1/:page_id/incidents/:template

Eksempel på svar:

{
  "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
}

Opdater hændelse

Endpoint:

PUT /v1/:page_id/incidents/:incident_id

Eksempel på forespørgsel:

{
  "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"
    }
  }
}

Eksempel på svar:

{
  "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"
    }
  }
}

Slet hændelse

Endpoint:

DELETE /v1/:page_id/incidents/:incident_id

Eksempel på svar:

{
  "id": "ckf02l5m8z36j0a35qr9q1tq1"
}

Hent en hændelses respondenter

Hvem der blev tilkaldt til en hændelse via vagtplanen, om nogen har kvitteret for den, og hvem der leder den.

Endpoint:

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

Eksempel på svar:

{
  "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
    }
  ]
}

Kvittér for en hændelse

Kvittér for en hændelse som API-nøglens bruger. Den første kvittering annullerer enhver eskalering, der stadig venter på at tilkalde flere personer, og gør den person til leder af hændelsen, hvis der ikke er nogen. Intet ændres på statussiden. Det er sikkert at kvittere igen: alreadyAcknowledged er så true.

Endpoint:

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

Eksempel på svar:

{
  "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
    }
  ]
}