NUnullplatform
Workflow signals

Send a signal to an execution

Changed on

Delivers a signal to an execution waiting on it. The request body is passed through verbatim as the signal payload. Returns 409 when the execution is not waiting on that signal.

post/workflows/executions/{id}/signals/{name}

Request

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

Path parameters

idstring required

The execution id.

namestring required

The signal name the execution is waiting on.

Request body

object required

Arbitrary JSON, delivered as the signal payload.

Example request

{
  "approved": true,
  "comment": "lgtm"
}

Response

The signal was delivered.

deliveredtrue
signalIdstring

Example response

{
  "signalId": "sig_a1b2c3d4e5f60718"
}

Changes