Search Storyblok's Documentation
  1. Create a Workflow

Create a Workflow

This end point creates a new workflow.

https://mapi.storyblok.com/v1/spaces/:space_id/workflows

Path Parameters

  • :space_id

    number

    Numeric ID of a space

Request Body Properties

  • workflow

    Workflow Object
    • content_types

      required string[]

      Array of content types associated with this workflow. At least one content type is required for a custom workflow.

    • name

      required string

      Workflow name

Response Properties

  • workflow

    Workflow Object
    • id

      number

      The numeric ID

    • content_types

      string[]

      Array of content types associated with this workflow. At least one content type is required for a custom workflow.

    • is_default

      boolean

      True if the workflow is default one

    • name

      string

      Workflow name

Example Request

Request
curl "https://mapi.storyblok.com/v1/spaces/606/workflows" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -d "{\"workflow\": {\"name\": \"page\",\"content_types\": [\"page\"]}}"
Request
// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.post('/spaces/606/workflows', {
  "workflow": {
    "name": "page",
    "content_types": [
     "page"
     ]
  }
})
  .then(response => {
    console.log(response)
  }).catch(error => { 
    console.log(error)
  })
Request
$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');

$payload = [
  "workflow" =>  [
    "name" =>  "page",
    "content_types" =>  [
     "page"
     ]
  ]
];

$client->post('/spaces/606/workflows', $payload)->getBody();
Request
require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')

payload = {
  "workflow" =>  {
    "name" =>  "page",
    "content_types" =>  [
     "page"
     ]
  }
}

client.post('/spaces/606/workflows', payload)
Request
HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/spaces/606/workflows")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body("{\"workflow\": {\"name\": \"page\",\"content_types\": [\"page\"]}}")
  .asString();
Request
var client = new RestClient("https://mapi.storyblok.com/v1/spaces/606/workflows");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"workflow\": {\"name\": \"page\",\"content_types\": [\"page\"]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Request
import Foundation

let headers = [
  "Content-Type": "application/json",
  "Authorization": "YOUR_OAUTH_TOKEN"
]

let postData = NSData(data: "{\"workflow\": {\"name\": \"page\",\"content_types\": [\"page\"]}}".data(using: String.Encoding.utf8)!)
let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/606/workflows")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)

request.method = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
Request
import requests

url = "https://mapi.storyblok.com/v1/spaces/606/workflows"

querystring = {}

payload = "{\"workflow\": {\"name\": \"page\",\"content_types\": [\"page\"]}}"
headers = {
  'Content-Type': "application/json",
  'Authorization': "YOUR_OAUTH_TOKEN"
}

response = requests.request("POST", url, data=payload, headers=headers, params=querystring)

print(response.text)

You will receive a workflow object as a response.