Create an issue

Create an issue in a project, returning an existing open issue when root-cause deduplication finds a match.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

projectId?string

Project to create the issue in. Auto-filled from CLI and SDK context when omitted.

Formatuuid

name?string

Stable issue name for indexing and mute matching. When omitted, the name is derived from contentMdx.

Length1 <= length

contentMdx?string

Safe Sazabi MDX document for the issue body (impact, root cause, remediation, evidence). Required unless sample is true.

Length1 <= length

severity?string

Issue severity used for prioritization and triage.

Default"medium"

Value in

"low"
"medium"
"high"
"critical"

componentId?string

UUID of a registered component this issue belongs to. Required unless sample is true: every issue must be attributed to a component. List components first and pick the best match; register one if none fits. Missing or unknown IDs are rejected.

Formatuuid

statusStartedAt?string

Optional ISO timestamp for when the linked status-page incident began.

Formatdate-time

sample?boolean

When true, creates (or returns) the organization's onboarding sample issue for the target project using the curated sample payload, and the alert rides the normal issue_triggered broadcast to the configured delivery rules. Mutually exclusive with the content inputs (name, contentMdx, severity, componentId, statusStartedAt); projectId stays allowed. Idempotent per project: an existing sample attempt's issue is returned instead of creating a new one. Requires a user credential.

Response Body

`application/json`

curl -X POST "https://example.com/issues" \  -H "Content-Type: application/json" \  -d '{}'

{  "issue": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",    "name": "string",    "description": "string",    "status": "open",    "severity": "low",    "componentId": "616ccd92-d666-4180-8349-8d125b269fac",    "createdAt": "2019-08-24T14:15:22Z",    "resolvedAt": "2019-08-24T14:15:22Z",    "mutedAt": "2019-08-24T14:15:22Z",    "muteHitCount": 0,    "lastActivityAt": "2019-08-24T14:15:22Z",    "lastDeliveredAt": "2019-08-24T14:15:22Z",    "locked": true,    "redacted": true  },  "duplicateIssueId": "a3608f73-8748-4976-a652-e89484bdc683"}

Request Body

Response Body

201application/json

`application/json`