Skip to main content
POST
workflow.execution.signal-with-start

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
workflowKey
string
required

Your key for this workflow, unique among its open runs.

Pattern: ^[A-Za-z0-9_.:@-][A-Za-z0-9_.:@ -]{0,399}$
workflowType
string
required

The workflow type your workers run.

Pattern: ^[A-Za-z0-9_.:@-][A-Za-z0-9_.:@ -]{0,199}$
taskQueue
string
required

The task queue your workers poll.

Pattern: ^[A-Za-z0-9_.:@-][A-Za-z0-9_.:@ -]{0,199}$
signalName
string
required

The signal to send.

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

Arguments for the workflow if it is started.

Maximum array length: 20
signalArguments
(string | number | boolean | null | any[] | object)[]

Arguments for the signal.

Maximum array length: 20
executionTimeoutSeconds
integer

Longest the workflow may run, retries and continues included.

Required range: 1 <= x <= 315360000
runTimeoutSeconds
integer

Longest one run may take.

Required range: 1 <= x <= 315360000
taskTimeoutSeconds
integer

Longest one workflow task may take.

Required range: 1 <= x <= 120
ifRunning
enum<string>

When a run with this key is open: signal it (default) or end it at once, with no cleanup, and start anew (needs confirm: true).

Available options:
use_existing,
terminate_existing
confirm
boolean

Required with ifRunning terminate_existing: the open run cannot be brought back.

ifClosed
enum<string>

Whether a key whose earlier run closed may start again. Default allow.

Available options:
allow,
allow_failed_only,
reject
retry
object

Retry rules for the workflow.

Response

The result

started
boolean
required

True when this call started a new run; false when it signalled an open one.

ref
string

Reference to what this call created. Pass it as ref to workflow.execution.history, workflow.execution.query, workflow.execution.signal, workflow.execution.result and the other workflow.execution.* calls.