API reference / Routines and triggers
Read a trigger
One trigger with its newest events: where each stands, and the task that holds it. Only owners and admins get what an event said.
/api/v1/triggers/{id}Other ways to call it
troopy triggers gettroopy_get_triggerPath parameters
id*stringA 24-character id
Response
200 · application/jsondata*object18 properties
id*stringA 24-character id
agent*stringThe handle of the teammate that it starts
name*stringtask*stringWhat the teammate does with each event
source*enum<string>webhook: a request to its URL starts it. event: something in a product of Troopy starts it
webhookevent
event*enum<string> | nullWhat starts it in Troopy, like customer.cancel_requested. Null for a webhook
customer.signed_upcustomer.trial_startedcustomer.subscribedcustomer.payment_failedcustomer.cancel_requestedcustomer.churnedcustomer.came_backcustomer.risk_raisedfeedback.addeddispute.openeddispute.closedoutreach.replymailbox.mailticket.releasedanalytics.spikeanalytics.drop
option*string | nullWhat narrows its event: for mailbox.mail, the id of one mailbox. For customer.signed_up, work_email. Null for every one
sender*enum<string>Who sends the requests of a webhook. It says how Troopy checks each one
urlgithubstripeshopifystandardhmac
needsSecret*booleanIts sender makes the signing secret, and Troopy does not have it yet. Troopy refuses each request until then
fields*array<string>The paths of an event that reach the teammate, like issue.title. Empty: the whole event
maxPerDay*integerThe most tasks that it starts in a UTC day. Later events of the day are held
eventsPerTask*integerThe most events that one task holds
paused*booleanpausedWhy*string | nullWhy Troopy paused it. Null when a person paused it, or it is on
lastEventAt*string | nulltoday*objectIts events, and the tasks that it started, in this UTC day
2 properties
events*integertasks*integercreatedAt*stringISO 8601 date and time
events*array<object>Its newest events, the newest first, 50 at most
8 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