API reference / Routines and triggers
Run a held event
Starts the teammate on an event that started nothing: its trigger was paused, or it was past the limit of the day. The trigger must be on. The limit of the day does not hold it back. Needs an owner or admin.
/api/v1/triggers/{id}/events/{event}/runOther ways to call it
troopy triggers run-eventtroopy_run_trigger_eventIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Path parameters
id*stringA 24-character id
event*stringA 24-character id
Response
200 · application/jsondata*object8 properties
id*stringA 24-character id
at*stringISO 8601 date and time
summary*stringWhat the sender calls the event, like issues.opened or invoice.paid. For an event of Troopy, its id. Empty when the sender does not say
test*booleanA person sent it with Send test event
state*enum<string>waitingtaskheld
why*enum<string> | nullWhy it started nothing: paused, or the limit of the day
pausedlimit
task*object | nullThe task that holds it. Its status says how the work goes
2 properties
key*stringstatus*enum<string>backlogtodoin_progressneeds_youin_reviewdonecanceled
text*string | nullWhat the event said, as Troopy keeps it: at most 48,000 characters, with secrets hidden. An event of Troopy names its record. Owners and admins only