Skip to content

A trial was detected

POST

Delivered as a CloudEvents 1.0 envelope whose data is a Trial. 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.intel.trial.detected
data
required
object
id
required

Prefixed ULID (trl_…)

string
/^trl_[0-9A-HJKMNP-TV-Z]{26}$/
vendor
required
string
vendorDomain
One of:
string
product
One of:
string
startedAt
One of:
string format: date-time
endsAt
One of:
string format: date-time
postTrialAmountCents
One of:
integer
cadence
required
string
Allowed values: weekly monthly quarterly annual usage one_time unknown
annualizedCents
One of:
integer
cancellationPath
One of:
string
decision
required
string
Allowed values: undecided keep stop remind
remindAt
One of:
string format: date-time
evidenceLevel
required

CONFIRMED = direct platform/API/settlement evidence; DETECTED = reliable statement/email/invoice evidence; ESTIMATED = calculation from observable rates or incomplete evidence. An estimate is never presented as confirmed.

string
Allowed values: CONFIRMED DETECTED ESTIMATED
confidence
required
number
evidence
required
Array<object>
object
kind
required
string
Allowed values: email statement api invoice contract receipt user derived
ref
required
string
sourceId
string
observedAt
required
string format: date-time
excerpt
string
<= 300 characters
worthIt
One of:
object
daysRemaining
One of:
number
activeDays
One of:
integer
lastDetectedActivityAt
One of:
string format: date-time
estimatedCostPerActiveDayCents
One of:
integer
verdict
required
string
Allowed values: likely_worth_it unclear likely_not_worth_it
rationale
required
Array<string>
updatedAt
required
string format: date-time

Acknowledge with any 2xx within 10 seconds