foliot docs

API reference / Signals / Deliver a signal by business key

Deliver a signal by business key

POST/apps/{appId}/signals

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

Routes to the most recently created ACTIVE run carrying that key, so a caller that only knows its own identifier does not have to track run ids.

Path parameters

appId
string
REQUIRED

The app's name.

Request body

businessKey
string
REQUIRED

min length 1

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
workflow
string
REQUIRED

min length 1

Responses

200 object 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.