NUnullplatform
Workflow signals

Send a signal by correlation key

Changed on

Delivers a signal to the non-terminal execution of workflowId matching correlationKey. With startIfMissing: true, starts a new execution (using startInputs) when none is waiting.

post/workflows/signals/{name}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/workflows/signals/{name}
  • Auth
    HTTP bearer

Path parameters

namestring required

The signal name.

Request body

correlationKeystring required
workflowIdstring required
payloadunknown
aliasNamestring
revisioninteger
startIfMissingboolean
startInputsobject

Run inputs used only when a new execution is started.

Example request

{
  "correlationKey": "jira:PROJ-123",
  "workflowId": "wf_ifWBbWfpug0n"
}

Response

The signal was delivered (or a new execution started).

deliveredtrue
executionIdstring
startedboolean

Changes