Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Routines and triggers

Send a test event

Sends an example event to a trigger that is on. It starts the teammate for real, and the task says that it is a test. The limit of the day does not hold it back. Needs an owner or admin.

post/api/v1/triggers/{id}/test

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy triggers test
MCP tooltroopy_test_trigger
Rate limit10 calls in 60 seconds, for each key
RetriesSend an Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.

Path parameters

id*string

A 24-character id

Response

201 · application/json
data*object
8 properties
id*string

A 24-character id

at*string

ISO 8601 date and time

summary*string

What 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*boolean

A person sent it with Send test event

state*enum<string>

waitingtaskheld

why*enum<string> | null

Why it started nothing: paused, or the limit of the day

pausedlimit

task*object | null

The task that holds it. Its status says how the work goes

2 properties
key*string
status*enum<string>

backlogtodoin_progressneeds_youin_reviewdonecanceled

text*string | null

What 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

Errors

400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.