Workflows
Create Workflow
Create a new workflow for the current account.
POST
/
api
/
v1
/
workflows
Create Workflow
curl --request POST \
--url https://api.example.com/api/v1/workflows \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"trigger": {
"type": "<string>",
"event": "<string>",
"collection": "<string>",
"condition": "<string>"
},
"description": "<string>",
"steps": [
{}
],
"enabled": true
}
'import requests
url = "https://api.example.com/api/v1/workflows"
payload = {
"name": "<string>",
"trigger": {
"type": "<string>",
"event": "<string>",
"collection": "<string>",
"condition": "<string>"
},
"description": "<string>",
"steps": [{}],
"enabled": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
trigger: {
type: '<string>',
event: '<string>',
collection: '<string>',
condition: '<string>'
},
description: '<string>',
steps: [{}],
enabled: true
})
};
fetch('https://api.example.com/api/v1/workflows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/workflows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'trigger' => [
'type' => '<string>',
'event' => '<string>',
'collection' => '<string>',
'condition' => '<string>'
],
'description' => '<string>',
'steps' => [
[
]
],
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/workflows"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"trigger\": {\n \"type\": \"<string>\",\n \"event\": \"<string>\",\n \"collection\": \"<string>\",\n \"condition\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"steps\": [\n {}\n ],\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/workflows")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"trigger\": {\n \"type\": \"<string>\",\n \"event\": \"<string>\",\n \"collection\": \"<string>\",\n \"condition\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"steps\": [\n {}\n ],\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"trigger\": {\n \"type\": \"<string>\",\n \"event\": \"<string>\",\n \"collection\": \"<string>\",\n \"condition\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"steps\": [\n {}\n ],\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"account_id": "<string>",
"name": "<string>",
"description": "<string>",
"trigger_type": "<string>",
"trigger_config": {},
"steps": [
{}
],
"enabled": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Body
application/json
Required string length:
1 - 200- EventTriggerConfig
- ScheduleTriggerConfig
- ManualTriggerConfig
- WebhookTriggerConfig
Show child attributes
Show child attributes
Ordered list of step definition dicts
Response
Successful Response
⌘I
Create Workflow
curl --request POST \
--url https://api.example.com/api/v1/workflows \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"trigger": {
"type": "<string>",
"event": "<string>",
"collection": "<string>",
"condition": "<string>"
},
"description": "<string>",
"steps": [
{}
],
"enabled": true
}
'import requests
url = "https://api.example.com/api/v1/workflows"
payload = {
"name": "<string>",
"trigger": {
"type": "<string>",
"event": "<string>",
"collection": "<string>",
"condition": "<string>"
},
"description": "<string>",
"steps": [{}],
"enabled": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
trigger: {
type: '<string>',
event: '<string>',
collection: '<string>',
condition: '<string>'
},
description: '<string>',
steps: [{}],
enabled: true
})
};
fetch('https://api.example.com/api/v1/workflows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/workflows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'trigger' => [
'type' => '<string>',
'event' => '<string>',
'collection' => '<string>',
'condition' => '<string>'
],
'description' => '<string>',
'steps' => [
[
]
],
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/workflows"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"trigger\": {\n \"type\": \"<string>\",\n \"event\": \"<string>\",\n \"collection\": \"<string>\",\n \"condition\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"steps\": [\n {}\n ],\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/workflows")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"trigger\": {\n \"type\": \"<string>\",\n \"event\": \"<string>\",\n \"collection\": \"<string>\",\n \"condition\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"steps\": [\n {}\n ],\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"trigger\": {\n \"type\": \"<string>\",\n \"event\": \"<string>\",\n \"collection\": \"<string>\",\n \"condition\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"steps\": [\n {}\n ],\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"account_id": "<string>",
"name": "<string>",
"description": "<string>",
"trigger_type": "<string>",
"trigger_config": {},
"steps": [
{}
],
"enabled": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}