Skip to content
Trusty Sweep Developers

A signed execution receipt was issued

POST

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

Request Body

Section titled “Request Body”
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

Https://api.trustysweep.com

string
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.receipt.issued
data
required

Durable, tamper-evident execution receipt signed with the platform Ed25519 key published at /.well-known/sweep-receipts.json.

object
receiptVersion
required
string
Allowed values: 1
receiptId
required

Prefixed ULID (rcp_…)

string
/^rcp_[0-9A-HJKMNP-TV-Z]{26}$/
executionId
required

Prefixed ULID (exe_…)

string
/^exe_[0-9A-HJKMNP-TV-Z]{26}$/
planId
required

Prefixed ULID (pln_…)

string
/^pln_[0-9A-HJKMNP-TV-Z]{26}$/
planHash
required
string
tenantRef
required
string
actor
required
object
type
required
string
Allowed values: user sweep_automation developer_application external_agent service connector
principalId
required
string
delegatingUserId
One of:
string
applicationId
One of:
string
agentId
One of:
string
grantId
One of:
string
delegatingUserId
One of:
string
authorization
required
object
actionDecisionId
required
string
grantId
One of:
string
commercialAuthorizationId
One of:
string
policyVersion
required
string
rateCardVersion
One of:
string
intent
required
string
simulated
required
boolean
attempted
required
integer
completed
required
integer
failed
required
integer
objects
required
Array<object>
object
assetId
required
string
providerObjectId
required
string
actions
required
Array<string>
status
required
string
Allowed values: completed partial failed skipped
vaultObjectId
One of:
string
vaultSha256
One of:
string
providerResultId
One of:
string
bytes
integer
error
One of:
string
restorable
boolean
before
required
Array<object>
object
sourceId
required
string
provider
required
string
Allowed values: google_gmail google_drive microsoft_outlook microsoft_onedrive dropbox apple_local s3_compatible trusty_vault simulated
usedBytes
One of:
integer
limitBytes
One of:
integer
observedAt
required
string format: date-time
after
required
Array<object>
object
sourceId
required
string
provider
required
string
Allowed values: google_gmail google_drive microsoft_outlook microsoft_onedrive dropbox apple_local s3_compatible trusty_vault simulated
usedBytes
One of:
integer
limitBytes
One of:
integer
observedAt
required
string format: date-time
bytesPreserved
required
integer
bytesRemoved
required
integer
bytesTransferred
required
integer
measuredReclaimBytes
One of:
integer
charges
required
Array<object>
object
meter
required
string
quantity
required
number
unit
required
string
cents
required
integer
usageEventId
required
string
startedAt
required
string format: date-time
finishedAt
required
string format: date-time
restoration
required
object
capable
required
boolean
until
One of:
string format: date-time
method
One of:
string
errors
Array<string>
hash

Sha256 of canonical JSON of the receipt without hash/signature

string
signature
object
alg
required
string
Allowed values: Ed25519
kid
required
string
sig
required

Base64url Ed25519 signature over hash

string

Responses

Section titled “Responses”

200

Section titled “200”

Acknowledge with any 2xx within 10 seconds