API reference / Routines and triggers
List triggers
The triggers of the workspace: each starts a teammate when an event comes, with a task for the work. A webhook trigger takes requests at its own URL. An event trigger starts on something in a product of Troopy. The URL and the secret of a trigger show in the app only.
/api/v1/triggersOther ways to call it
troopy triggers listtroopy_list_triggersQuery parameters
agentstringThe teammate's handle, like chief
At most 40 characters
Response
200 · application/jsondata*array<object>17 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