Create an issue

Create an issue in a project. When root-cause deduplication finds a match, no issue is created: the existing open issue is returned with created: false and records the report as a recurrence.

POST https://api.sazabi.com/v1/issues

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

sourceThreadId?string

The existing conversation that requested this issue. Must be accessible to the caller and belong to the same project. Slack delivery to that conversation's channel replies in its thread.

Formatuuid

clientRequestId?string

Optional caller-supplied idempotency key. Reuse it only when retrying the same logical issue creation request; concurrent or timed-out retries with the same key reuse one issue and one usage-budget admission.

Length1 <= length <= 200

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: at most 80 characters, plain English without emojis, in the form ": ", without counts, timestamps, or internal identifiers. When omitted, the name is derived from contentMdx.

Length1 <= length

contentMdx?string

Issue report sent to the customer's engineer as written. Write brief, natural paragraphs without emojis, em dashes, headings or section labels. Lead with the observed problem and who is affected. Preserve measured scope, populations, denominators, time windows, useful diagnostics and verified evidence links. Separate observed impact from hypotheses; an exception or unhandled flag does not establish a failed request or customer harm. When the caller outcome is unknown, use this structure: your service reported the error at one useful code location; the operation outcome is unclear; optionally, conditional completion telemetry advice. Do not explain exception-handler mechanics or assume how the application should normally handle the error. State unknown outcomes directly, without apologies or a list of missing fields. End when the finding is complete: do not append a generic inspect/check command or repeat the diagnosis as a next step. Recommend a behavioral fix only after inspecting relevant code. When an important outcome remains unknown, query existing evidence first; if telemetry coverage is unknown, conditionally suggest the specific outcome fields and request/trace correlation that would clarify future occurrences. An absent field in one event does not prove telemetry is absent everywhere. At most 120 prose words and 3000 characters after Slack formatting; no minimum length. Keep literal technical evidence unchanged, omit irrelevant SDK metadata and Sazabi identifiers. Required unless sample is true.

Length1 <= length

severity?string

Issue severity, by impact. critical: Happening now in production: an outage of the service, of a flow most users depend on, or of a whole feature; or data loss, a security exposure, or failed payments. high: Happening now in production: at least 1% of attempts failing or a region down; or production data loss, exposure, or failed payments that has stopped. medium: A failure limited to a few users or one path, a broad internal failure, a production outage that ended on its own, or serious harm outside production. low: No user or system impact, a transient blip, an internal failure on one item or a rare path, or other work outside production, including eval, training, and canary runs. When omitted, the issue is stored as medium and recorded as defaulted.

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

suspectedPullRequest?

Optional GitHub or Bitbucket pull request suspected of causing this issue. The repository does not need to be connected to the project.

sample?boolean

Deprecated: the sample-issue onboarding step is a static exhibit and no longer creates an issue. Kept as a compat shim for @sazabi/cli <= 1.7.0 — the server marks the onboarding sample-issue step complete and returns a synthetic non-persisted issue snapshot. Mutually exclusive with the content inputs (name, contentMdx, severity, componentId, statusStartedAt); projectId stays allowed. 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",    "componentName": "string",    "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  },  "created": true,  "message": "string",  "duplicateIssueId": "a3608f73-8748-4976-a652-e89484bdc683",  "possibleDuplicateOfIssueId": "2071f671-41ad-400f-8cfb-56a8f9246d8c"}

Request Body

Response Body

201application/json

`application/json`