Skip to main content
POST
/
api
/
incidents
/
v1
CreateIncident
curl --request POST \
  --url https://developer.synq.io/api/incidents/v1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "actor": {
    "name": "<string>",
    "email": {
      "userEmail": "[email protected]"
    }
  },
  "at": "2023-11-07T05:31:56Z",
  "issueIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "groupIds": [
    "<string>"
  ],
  "ownerEmail": "<string>"
}
'
{
  "incident": {
    "id": "<string>",
    "index": 123,
    "name": "<string>",
    "issueIds": [
      "<string>"
    ],
    "createdBy": {
      "name": "<string>",
      "email": {
        "userEmail": "[email protected]"
      }
    },
    "owner": {
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedBy": {
      "name": "<string>",
      "email": {
        "userEmail": "[email protected]"
      }
    },
    "updatedAt": "2023-11-07T05:31:56Z",
    "state": "STATE_UNSPECIFIED",
    "comments": [
      {
        "id": "<string>",
        "message": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "actor": {
          "name": "<string>",
          "email": {
            "userEmail": "[email protected]"
          }
        }
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Name of the incident

actor
Actor · object
required

Actor creating the incident

at
string<date-time>
required

Time at which the incident was created. Defaults to the current time. timestamp.gt = 2022-01-01T00:00:00Z timestamp.gt_lt = 2022-01-01T00:00:00Z timestamp.gt_lt_exclusive = 2022-01-01T00:00:00Z timestamp.gt_lte = 2022-01-01T00:00:00Z timestamp.gt_lte_exclusive = 2022-01-01T00:00:00Z timestamp.lt_now = true

issueIds
string<uuid>[]

IDs of issues to add to the incident

Minimum array length: 1
groupIds
string[]

Optional group IDs associated with the incident

ownerEmail
string

Response

200 - application/json

Success

incident
Incident · object