Skip to content

A plan needs human step-up approval

POST

Delivered as a CloudEvents 1.0 envelope whose data is a PlanAuthorization. Batched ≤ 20 per delivery as a JSON array; signed with Sweep-Signature.

Media typeapplication/json
Array
object
specversion
required
string
Allowed values: 1.0
id
required

Prefixed ULID (evt_…)

string
/^evt_[0-9A-HJKMNP-TV-Z]{26}$/
source
required
type
required

Event type from events.json, e.g. sweep.execution.completed

string
time
required
string format: date-time
subject

Primary resource id

string
datacontenttype
string
Allowed values: application/json
data
required
object
key
additional properties
sweepsimulated

CloudEvents extension: true in developer test mode.

boolean
type
required
Allowed value: sweep.plan.step_up_required
data
required
object
plan_id
required

Prefixed ULID (pln_…)

string
/^pln_[0-9A-HJKMNP-TV-Z]{26}$/
status
required
string
Allowed values: authorized step_up_required denied
plan_hash
required
string
policy
required
object
policyVersion
required
string
decision
required
string
Allowed values: allow deny step_up_required
reasons
required
Array<string>
requiredApprovals
Array<string>
Allowed values: human_user developer_owner ceiling_increase scope_step_up
decisionId
string
commercial
One of:
object
authorized
required
boolean
authorization_id
One of:
string
reason
string
approval_url
One of:
string format: uri
approval_expires_at
One of:
string format: date-time

Acknowledge with any 2xx within 10 seconds