Skip to content
Trusty Sweep Developers

A source was connected

POST

Delivered as a CloudEvents 1.0 envelope whose data is a Source. 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.source.connected
data
required
object
id
required

Prefixed ULID (src_…)

string
/^src_[0-9A-HJKMNP-TV-Z]{26}$/
provider
required
string
Allowed values: google_gmail google_drive microsoft_outlook microsoft_onedrive dropbox apple_local s3_compatible trusty_vault simulated
kind
required
string
external_account_id
required
string
display_name
required
string
email
One of:
string
status
required
string
Allowed values: connected reauth_required revoked disconnected error pending
granted_scopes
Array<string>
granted_operations
required
Array<string>
Allowed values: discover preserve write remove restore migrate monitor automate billable_execute
connected_at
required
string format: date-time
last_scan_at
One of:
string format: date-time
last_delta_marker
One of:
string
connected_via_application_id
One of:

Prefixed ULID (app_…)

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

Prefixed ULID (cxn_…)

string
/^cxn_[0-9A-HJKMNP-TV-Z]{26}$/
simulated
required
boolean
policy
object
version
string
minAgeDays
integer
minSizeBytes
integer
excludeSenders
Array<string>
excludeDomains
Array<string>
excludeLabels
Array<string>
excludeFolders
Array<string>
excludeStarred
boolean
excludeShared
boolean
excludeRecentDays
integer
preserveMimeTypes
Array<string>
preserveKeywords
Array<string>
removePromotional
boolean
duplicateHandling
string
Allowed values: keep_newest keep_oldest review
sourceAction
string
Allowed values: trash none
preservation
string
Allowed values: vault_all vault_preserve_class_only
quota
One of:
object
used_bytes
required
integer
limit_bytes
required
One of:
integer
trash_bytes
integer
breakdown
object
key
additional properties
integer
observed_at
required
string format: date-time
growth_bytes_per_day
One of:
number
projected_full_at
One of:
string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

Acknowledge with any 2xx within 10 seconds