Skip to content

by Startups.Studio

Product Build and ship Issue

Issue.create

POST /{namespace}/issues

Creates an Issue.

Noun: Issue
Mode: do
Event: Issue.created

You, to your agent

Add an issue to ShiftNote.

curl -X POST https://api.sb/shiftnote.app/issues \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"by":"worker_1"}'

import { $ } from 'startup-builder'

const issue = await $.Issue.create({ by: 'worker_1' })

npx startup-builder do Issue.create --json '{"by":"worker_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Issue.create({ by: 'worker_1' })"
  }
}

Create makes a new Issue from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`by`	Worker		The Worker that performed it.
`for`	Party		The Party it was done on behalf of.
`via`	`string`		The Interface or request it arrived through.
`on`	`string`		The Action or Event that caused it, such as the failed attempt a retry follows.
`thing`	`string`		The record, at the Version the Action was decided against.
`input`	`json`		The input it was called with.
`createdAt`	`datetime`		When it was called.
`reserved`	`money`		The most this Action may cost, held against its Limits from the check until it settles, billed misses included.
`due`	`datetime`		When the Task is due.
`priority`	`integer`		Its rank in the inbox, highest first.
`recurrence`	`string`		The schedule a recurring duty repeats on.
`kind`	`string`		One of `bug`, `request`, or `question`.
`severity`	`string`		Set by triage; a vulnerability takes `critical`, `high`, `medium` or `low`, which sets `due`. An Incident keeps its own scale.
`advisory`	`string`		For a vulnerability: the public advisory it matches, with the affected package and range.

Outputs

Output	Type	Required	Description
`issue`	Issue	required	The Issue.

Effects

Emits Issue.created.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Issue.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Issue

Previous Page

Issue.delete

Next Page