POST
/
api
/
v1
/
incidents
/
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.incidents.create({
    description: "Service outage in region X",
    startDatetime: new Date("2023-10-01T08:00:00Z"),
    resolutionDatetime: new Date("2023-10-01T12:00:00Z"),
    impactCategory: "High",
    sessionsImpacted: 1500,
    markdown: "**Incident Details**",
    organizationId: 123,
    subOrganizationId: 456,
    subOrganization: "SubOrg A",
  });

  // Handle the result
  console.log(result);
}

run();
{
  "description": "Service outage in region X",
  "start_datetime": "2023-10-01T08:00:00Z",
  "resolution_datetime": "2023-10-01T12:00:00Z",
  "impact_category": "High",
  "sessions_impacted": 1500,
  "markdown": "**Incident Details**",
  "organization_id": 123,
  "sub_organization_id": 456,
  "sub_organization": "SubOrg A",
  "id": 1,
  "created_at": "2023-10-01T08:00:00Z",
  "updated_at": "2023-10-01T08:00:00Z",
  "last_updated_by": "user@mail.com"
}

Authorizations

Syllable-API-Key
string
header
required

Body

application/json

Request model to create a service incident.

Response

200
application/json

Successful Response

Response model for service incident operations.