Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Support Agent

Make a bug ticket of a chat

Makes an engineering ticket, kind bug and label support, of a problem that a visitor reports in the chat. The Engineer analyzes and plans it, and reads the report and the chat on its card. A person always approves its plan, and Troopy never releases it by itself, because the words of a visitor steer it. A chat has one open ticket: while it is open, a new report goes on it (added: true). The Support agent makes 5 tickets a day in a workspace. People make more. brief: what the visitor saw, where, and what they tried. Mark each detail that is not known as not known.

post/api/v1/support-conversations/{id}/ticket

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 support ticket
MCP tooltroopy_file_support_ticket
Rate limit20 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

Body

application/json
brief*string

What the visitor saw, where, and what they tried, 2,000 characters at most

At least 10 characters · At most 2000 characters

wherestring

The page or the part of the product, such as /checkout

At most 80 characters

Response

201 · application/json
data*object
2 properties
ticket*object
7 properties
key*string
title*string
status*enum<string>

backlogtodoin_progressneeds_youin_reviewdonecanceled

stage*enum<string> | null

The step of the engineering flow. Null: the ticket is not in the flow

analyzeplanbuildtestrelease

reports*integer

The reports of the visitor's problem that the ticket holds

liveAt*string | null

When the ticket went live. The team then tells the visitor that the problem is fixed

told*boolean

A person of the team replied to the visitor after the ticket went live

added*boolean

true: the report went on the open ticket of the chat

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.