Skip to content
Notavia Notavia Docs

Post an event to all waiting runs of a workflow

POST
/v1/workflows/{key}/events
 
curl --request POST \
  --url https://your-notavia-host/v1/workflows/example/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "event_name": "example", "event_data": {} }'

Delivers event_name to every run of this workflow currently in Waiting status (paused on a wait_for_event step whose event and match filter matches). Returns the number of runs awoken.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
key
required
string
/^[a-z][a-z0-9_]{0,99}$/

Workflow key — lowercase alphanumeric + underscore, max 100 chars.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
event_name
required

Name of the event to deliver (e.g. payment_confirmed).

string
<= 200 characters
event_data
required

Arbitrary JSON payload matched against the step’s match filter.

object
key
additional properties
any
Example generated
{
  "event_name": "example",
  "event_data": {}
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Event delivered; awoken run count returned.

Media type application/json
object
awoken_run_count
required

Number of runs that were awoken by this event.

integer
Example generated
{
  "awoken_run_count": 1
}

400

Section titled “400 ”

Validation or request error.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

401

Section titled “401 ”

Missing or invalid credentials.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

403

Section titled “403 ”

Credentials do not have the required scope.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}