Skip to main content
POST
workflow.execution.result

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
ref
string
required

The ref returned by workflow.execution.signal-with-start or workflow.execution.reset.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
waitSeconds
integer
default:0

Wait up to this long for the run to close. Default 0: answer at once.

Required range: 0 <= x <= 20

Response

The result

state
enum<string>
required

running until it closes. continued: the run handed over to a new run, which this ref does not follow.

Available options:
running,
completed,
failed,
cancelled,
terminated,
timed_out,
continued
value

What the workflow returned, when completed.

failure
string

The failure message, when failed.