Report Workflow Callback Progress
POST/api/automation/callbacks/:wait/progress
Report progress while a run is paused on a Wait for callback step. Records the message on the run and in the step's logs, and renews the step's heartbeat when it has one. The run stays paused.
Called by your own agent or script with the token SKU issued for this runner or callback, sent as Authorization: Bearer <token> — not with a Personal Access Token or a session.
Public endpoint, called on the account's own host (the host in {{ $execution.callbackUrl }}). Authenticate with Authorization: Bearer <callback token>, where the token is the value of {{ $execution.callbackToken }} handed out by an earlier step of the run - not a Personal Access Token.
Body
message(required, string, max 1000).percent(optional, integer 0-100).
Returns 202 {"status":"accepted"}. Errors: 401 invalid callback token; 409 the wait is already completed, failed, timed out or canceled (late and duplicate callbacks are never applied); 410 the run was deleted; 413 body larger than 256 KB; 422 validation error; 429 more than 60 calls a minute for this wait.
Request
Responses
- 202
- 401
- 403
- 404
- 409
- 410
- 413
- 422
- 429
Accepted
Response Headers
Unauthorized
Response Headers
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Conflict
Response Headers
Gone
Response Headers
Payload Too Large
Response Headers
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.