Skip to content

A Vault object was verified and committed

POST

Delivered as a CloudEvents 1.0 envelope whose data is a VaultObject. 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.vault.object.committed
data
required
object
id
required

Prefixed ULID (vlt_…)

string
/^vlt_[0-9A-HJKMNP-TV-Z]{26}$/
asset_id
One of:

Prefixed ULID (ast_…)

string
/^ast_[0-9A-HJKMNP-TV-Z]{26}$/
name
One of:
string
provider
One of:
string
Allowed values: google_gmail google_drive microsoft_outlook microsoft_onedrive dropbox apple_local s3_compatible trusty_vault simulated
source_id
One of:

Prefixed ULID (src_…)

string
/^src_[0-9A-HJKMNP-TV-Z]{26}$/
sha256
required
string
size_bytes
required
integer
mime_type
One of:
string
state
required
string
Allowed values: uploading verifying committed corrupt deleting deleted cold
created_at
required
string format: date-time
verified_at
One of:
string format: date-time
cold_since
One of:
string format: date-time
has_text
boolean
has_ocr
boolean
manifest_id
One of:

Prefixed ULID (mfs_…)

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

Acknowledge with any 2xx within 10 seconds