Skip to main content
POST
workflow.execution.update-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.update.

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

Wait up to this many seconds for the update to finish. Default 0: answer now.

Required range: 0 <= x <= 20

Response

The result

stage
enum<string>
required

How far the update got: pending (not finished within the wait; call again), admitted, accepted or completed.

Available options:
pending,
admitted,
accepted,
completed
succeeded
boolean

When completed: whether the handler succeeded.

value

What the handler returned, when it succeeded.

failure
string

The failure message, when it was rejected or failed.