Skip to main content
POST
workflow.execution.reset

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})$
confirm
boolean
required

Must be true: the current run is ended at once and cannot be restored.

eventSequence
integer
required

Sequence of a completed workflow task event (from workflow.execution.history) to reset to.

Required range: 2 <= x <= 9007199254740991
reason
string
required

Why, kept in the run's history.

Required string length: 1 - 500
keepSignals
boolean
default:true

Replay signals received after that point. Default true.

keepUpdates
boolean
default:true

Replay updates received after that point. Default true.

Response

The result

reset
boolean
required

Always true: the run was ended and a new run started from that point.

ref
string

Reference to what this call created. Pass it as ref to the workflow.execution.* calls, for the new run.