Skip to main content
POST
Report external coding-agent progress

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

project
string
required

Path Parameters

ticketId
string
required

Body

application/json

Body of POST /tickets/{ticketId}/agent-progress — the Gleap MCP report_progress tool. See services/agents/external.agent.progress.ts.

phase
enum<string>
required
Available options:
investigating,
reproduced,
fixing,
pr_opened,
blocked,
done
message
string
required

One-line status shown live in the dashboard (aim for ~10 words).

prUrl
string

Pull-request URL; registers the PR for resolve-on-merge.

agentName
string

Reporting agent's product name (e.g. "Claude Code", "Codex").

sessionId
string

Stable id for the agent's session, sent on every call — the upsert key that lets multiple agents work one ticket in parallel. Must match [A-Za-z0-9._-]{1,100}; anything else (and omitting it) falls back to agentName as the key.

customerShipMessage
string

Operator-approved customer "ship message" (plain text, max ~2000 chars), drafted while the agent still has full context. Gleap shows it on the ticket as a scheduled reply without a date and sends it automatically after the registered PR merges, per the project's post-merge timing settings; the ticket closes after delivery. Send it with pr_opened or done; the newest report replaces the draft.

Response

200 - application/json

Ok