API reference / Signals / Deliver a signal to a run

Deliver a signal to a run

POST/apps/{appId}/runs/{runId}/signals

Authenticate with an operator token or an app API key or a signed-in Foliot Console session.

Buffered when the run has not reached its wait step yet, so a webhook that arrives early is not lost. A repeated key is reported as a duplicate rather than delivered twice.

Path parameters

appId

string

REQUIRED

The app's name.

runId

string (uuid)

REQUIRED

Request body

key

string

OPTIONAL

Dedupe key. A repeat with the same key is reported duplicate, not delivered again.

max length 200

name

string

REQUIRED

min length 1 · max length 100

payload

any

OPTIONAL

Responses

200 SignalResult OK

400 Error Invalid request.

401 Error Missing, malformed or unknown bearer token.

403 Error The token is valid but not permitted on this route.

404 Error No such resource.

409 Error Conflicts with existing state.

503 Error A dependency this route needs is unreachable.

cURL

curl -X POST "https://api.foliot.app/apps/{appId}/runs/{runId}/signals" \
  -H "Authorization: Bearer $FOLIOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key":"string","name":"string","payload":null}'

RESPONSE 200 OK

{
  "buffered": true,
  "delivered": true,
  "duplicate": true
}