Emit a durable buffered workflow signal

POST /workflows/{id}/signals

Error

A valid request URL is required to generate request examples

200

{
  "matched": 2,
  "promoted": 1,
  "inserted": true,
  "emission": {
    "id": 2,
    "signal": "<string>",
    "idempotency_key": "<string>",
    "payload": "<unknown>",
    "source": "<unknown>",
    "recorded_at_ms": 123
  }
}

Headers

Idempotency-Key · string · required

Required on every mutating request. A double-clicked Retry, or a proxy retrying a POST, must not enqueue the job twice. Keys are retained long enough to cover a client retry window and the response is replayed verbatim.

Path Parameters

id · string · required

Body

application/json

signal · string · required

Minimum string length: 1

payload · any

Arbitrary JSON value delivered with the signal.

source · any

Caller-supplied JSON describing the emitter or calling system; authenticate and populate it at a trusted upstream boundary.

Response

200 - application/json

Idempotent signal receipt including the original durable emission.

matched · integer · required

Required range: x >= 1

promoted · integer · required

Required range: x >= 0

inserted · boolean · required

False when this idempotency key replayed an existing emission.

emission · object · required

Show child attributes