⌘ K

Referência da API de incidentes

Obter todos os incidentes da página

Endpoint:

GET /v1/:page_id/incidents?page=:page&per_page=:per_page
  • O número de página padrão é 1.
  • O per_page padrão é 50 e o máximo é 100 itens por página.

Exemplo de resposta:

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

Você pode usar os parâmetros de query status e !status para limitar os resultados a incidentes que têm ou não têm (respectivamente) um dos status de uma lista separada por vírgulas.

user é o membro do workspace que criou o incidente. É null quando o incidente foi criado automaticamente (por um monitor, uma integração de terceiros ou e-mail).

Obter um incidente

Endpoint:

GET /v1/:page_id/incidents/:incident_id

Exemplo de resposta:

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

Adicionar um incidente

Endpoint:

POST /v1/:page_id/incidents

Exemplo de requisição:

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

Por padrão, os incidentes são publicados na sua página de status. Se quiser criar um incidente não publicado, inclua shouldPublish e defina como false.

Exemplo de resposta:

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

Adicionar um incidente com um modelo

Endpoint:

POST /v1/:page_id/incidents/:template

Exemplo de resposta:

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

Atualizar incidente

Endpoint:

PUT /v1/:page_id/incidents/:incident_id

Exemplo de requisição:

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

Exemplo de resposta:

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

Excluir incidente

Endpoint:

DELETE /v1/:page_id/incidents/:incident_id

Exemplo de resposta:

{
  "id": "ckf02l5m8z36j0a35qr9q1tq1"
}

Obter os respondentes de um incidente

Quem foi acionado para um incidente pelo plantão, se alguém já o confirmou e quem é o responsável por ele.

Endpoint:

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

Exemplo de resposta:

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

Confirmar um incidente

Confirma um incidente como o usuário da chave de API. A primeira confirmação cancela qualquer escalonamento que ainda esteja aguardando para acionar mais pessoas e torna essa pessoa a responsável pelo incidente, se ainda não houver uma. Nada muda na página de status. Confirmar de novo é seguro: nesse caso, alreadyAcknowledged é true.

Endpoint:

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

Exemplo de resposta:

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