API reference / Tests and incidents
Add a test
Adds a test: a title and up to 30 steps in order. A step does something, checks what shows, or takes a picture. smoke puts it on the main path, which runs after each release. production says that no step changes data, so it can run on the live product. account names the test account that it signs in with. A teammate's test is proposed until a person makes it active. 500 tests at most.
/api/v1/testsOther ways to call it
troopy tests createtroopy_create_testIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Body
application/jsontitle*stringAt least 1 characters · At most 120 characters
steps*array<object>The steps in order. Troopy numbers them s1, s2 and so on
At most 30 items
2 properties
kind*enum<string>do: an action. check: what must show. picture: a picture to take
docheckpicture
text*stringAt least 1 characters · At most 500 characters
tagsarray<string>At most 10 items
smokebooleanproductionbooleanaccountstring | nullThe label of a test account of the place where it runs, or null
statusenum<string>A person's test is active unless paused. A teammate's is always proposed
activepaused
Response
201 · application/jsondata*object13 properties
id*stringA 24-character id
title*stringsteps*array<object>3 properties
id*strings1, s2 and so on, in order
kind*enum<string>do: an action. check: what must show. picture: a picture to take
docheckpicture
text*stringtags*array<string>smoke*booleanOn the main path: it runs after each release
production*booleanSafe for Production: no step changes data
account*string | nullThe label of the test account that it signs in with. null when it signs in with none
status*enum<string>A teammate's test is proposed until a person makes it active. A paused test does not run
proposedactivepaused
createdBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringupdatedBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringversion*integercreatedAt*stringISO 8601 date and time
updatedAt*stringISO 8601 date and time