Skip to content
Notavia Notavia Docs

Create a new workflow

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

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
key
required
string
/^[a-z][a-z0-9_]{0,99}$/
name
required
string
<= 200 characters
description
string
nullable <= 500 characters
Example generated
{
  "key": "example",
  "name": "example",
  "description": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Workflow created.

Media type application/json

A named, versioned, per-environment notification workflow.

object
id
required
string format: uuid
key
required

Stable slug, unique per environment. Pattern ^[a-z][a-z0-9_]{0,99}$.

string
name
required
string
description
string
nullable
status
required
string
Allowed values: draft active disabled
created_at
required
string format: date-time
Example 
{
  "status": "draft"
}

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"
  }
}

409

Section titled “409 ”

Conflict (e.g. duplicate key, idempotency collision).

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"
  }
}