Skip to content

KeyResult.create

POST /{namespace}/key-results

Creates a Key Result.

Mode
do
Event
KeyResult.created

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

Inputs

InputTypeRequiredDescription
baselinenumberrequiredWhere the Metric started.
targetnumberrequiredWhere the Metric must reach.
deadlinedaterequiredWhen it must reach it.
goalGoalA Goal is met when its Key Results reach their targets.
metricMetricA Key Result compares one Metric’s value against its baseline and target.

Outputs

OutputTypeRequiredDescription
keyResultKey ResultrequiredThe Key Result.

Effects

  • Emits KeyResult.created.
  • Two-way: try, send, do.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.KeyResult.create

When it waits

GateDefault
Decision classLow: two-way, nothing at stake
Delay windowNone: it runs once review passes.
LimitThe call Limit of the Permission it runs under.
Over the LimitIt 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.