Skip to main content
POST
workflow.execution.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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})$
updateName
string
required

The update your workflow handles.

Pattern: ^[A-Za-z0-9_.:@-][A-Za-z0-9_.:@ -]{0,199}$
arguments
(string | number | boolean | null | any[] | object)[]

Arguments for the update.

Maximum array length: 20
waitFor
enum<string>
default:completed

Answer once the workflow accepted the update, or once it finished. Default completed.

Available options:
accepted,
completed

Response

The result

stage
enum<string>
required

How far the update got before the answer: admitted (received, not yet accepted), accepted or completed.

Available options:
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.

ref
string

Reference to what this call created. Pass it as ref to workflow.execution.update-result, to read the outcome later.