Alert Episode

Create Alert Episode

Endpoint to create a new Alert Episode

post/alert-episode

Request

Request body

Example request

{
  "data": {
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "title": "This is an example of longer text content that provides detailed information."
  }
}

Response

Created successfully

Example response

{
  "data": {
    "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "project": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "title": "This is an example of longer text content that provides detailed information.",
    "description": null,
    "episodeNumber": 42,
    "episodeNumberWithPrefix": "Example Text",
    "currentAlertState": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "currentAlertStateId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "alertSeverity": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "alertSeverityId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "rootCause": null,
    "lastAlertAddedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "resolvedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "allAlertsResolvedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "firstPagedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "assignedToUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "assignedToUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "assignedToTeam": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "assignedToTeamId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "alertGroupingRule": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "alertGroupingRuleId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "onCallDutyPolicies": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "isOnCallPolicyExecuted": true,
    "alertCount": 42,
    "titleTemplate": "This is an example of longer text content that provides detailed information.",
    "descriptionTemplate": "This is an example of longer text content that provides detailed information.",
    "isManuallyCreated": true,
    "labels": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "createdByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "isOwnerNotifiedOfEpisodeCreation": true,
    "groupingKey": "This is an example of longer text content that provides detailed information.",
    "remediationNotes": null,
    "postUpdatesToWorkspaceChannels": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "isPrivate": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.