cURL
curl --request PUT \
--url https://app.stockshift.io/api/v1/automation/automations/{automation}/draft \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"definition": {
"trigger": {
"inputs": [
{
"key": "<string>",
"label": "<string>",
"required": true
}
],
"event": "<string>",
"schedule": {
"time": "<string>",
"weekday": 4,
"day": 16,
"timezone": "<string>"
}
},
"conditions": {
"rules": [
{
"field": "<string>",
"value": "<string>"
}
]
},
"steps": [
{
"key": "<string>",
"action": "<string>",
"inputs": [
{
"input": "<string>",
"value": "<string>",
"step": "<string>",
"field": "<string>"
}
],
"code": {
"source": "<string>"
}
}
]
}
}
'import requests
url = "https://app.stockshift.io/api/v1/automation/automations/{automation}/draft"
payload = { "definition": {
"trigger": {
"inputs": [
{
"key": "<string>",
"label": "<string>",
"required": True
}
],
"event": "<string>",
"schedule": {
"time": "<string>",
"weekday": 4,
"day": 16,
"timezone": "<string>"
}
},
"conditions": { "rules": [
{
"field": "<string>",
"value": "<string>"
}
] },
"steps": [
{
"key": "<string>",
"action": "<string>",
"inputs": [
{
"input": "<string>",
"value": "<string>",
"step": "<string>",
"field": "<string>"
}
],
"code": { "source": "<string>" }
}
]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stockshift.io/api/v1/automation/automations/{automation}/draft",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'definition' => [
'trigger' => [
'inputs' => [
[
'key' => '<string>',
'label' => '<string>',
'required' => true
]
],
'event' => '<string>',
'schedule' => [
'time' => '<string>',
'weekday' => 4,
'day' => 16,
'timezone' => '<string>'
]
],
'conditions' => [
'rules' => [
[
'field' => '<string>',
'value' => '<string>'
]
]
],
'steps' => [
[
'key' => '<string>',
'action' => '<string>',
'inputs' => [
[
'input' => '<string>',
'value' => '<string>',
'step' => '<string>',
'field' => '<string>'
]
],
'code' => [
'source' => '<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://app.stockshift.io/api/v1/automation/automations/{automation}/draft"
payload := strings.NewReader("{\n \"definition\": {\n \"trigger\": {\n \"inputs\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true\n }\n ],\n \"event\": \"<string>\",\n \"schedule\": {\n \"time\": \"<string>\",\n \"weekday\": 4,\n \"day\": 16,\n \"timezone\": \"<string>\"\n }\n },\n \"conditions\": {\n \"rules\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"steps\": [\n {\n \"key\": \"<string>\",\n \"action\": \"<string>\",\n \"inputs\": [\n {\n \"input\": \"<string>\",\n \"value\": \"<string>\",\n \"step\": \"<string>\",\n \"field\": \"<string>\"\n }\n ],\n \"code\": {\n \"source\": \"<string>\"\n }\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}{
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"enabled": true,
"archived": true,
"current_version": 123,
"has_draft": true,
"draft_saved_at": "<string>",
"definition": {
"trigger": {
"type": "manual",
"inputs": [
"<unknown>"
],
"event": "<string>",
"schedule": {
"frequency": "every_15_minutes",
"time": "<string>",
"weekday": 123,
"day": 123,
"timezone": "<string>"
}
},
"conditions": {
"match": "all",
"rules": [
"<unknown>"
]
},
"steps": [
"<unknown>"
]
},
"problems": [
{
"step": 123,
"input": "<string>",
"message": "<string>"
}
],
"versions": [
{
"number": 123,
"current": true,
"copied_from": 123,
"published_by": "<string>",
"published_at": "<string>"
}
],
"can_manage": true,
"can_publish": true,
"attention": "<string>",
"skipped_runs": 123,
"can_start": true,
"run_inputs": [
"<unknown>"
],
"secret_steps": [
"<string>"
],
"members": [
{
"id": 123,
"name": "<string>"
}
],
"roles": [
"<string>"
],
"not_started": "<string>",
"not_started_at": "<string>",
"waiting_triggers": 123,
"runs_per_minute": 123,
"next_run_at": "<string>",
"default_timezone": "<string>",
"template_key": "<string>",
"template_version": 123
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}Automations
Save an automation's draft
Replaces the draft’s definition, starting a draft when there is none.
A definition that breaks the schema is refused: more steps than the
organization allows, a step the catalog does not know, or an input
the step does not have. A mapping that does not fit its input is
kept, and listed in problems, which block publishing. Needs the
automation.automations.manage permission and a token with
automation:write.
PUT
/
automation
/
automations
/
{automation}
/
draft
cURL
curl --request PUT \
--url https://app.stockshift.io/api/v1/automation/automations/{automation}/draft \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"definition": {
"trigger": {
"inputs": [
{
"key": "<string>",
"label": "<string>",
"required": true
}
],
"event": "<string>",
"schedule": {
"time": "<string>",
"weekday": 4,
"day": 16,
"timezone": "<string>"
}
},
"conditions": {
"rules": [
{
"field": "<string>",
"value": "<string>"
}
]
},
"steps": [
{
"key": "<string>",
"action": "<string>",
"inputs": [
{
"input": "<string>",
"value": "<string>",
"step": "<string>",
"field": "<string>"
}
],
"code": {
"source": "<string>"
}
}
]
}
}
'import requests
url = "https://app.stockshift.io/api/v1/automation/automations/{automation}/draft"
payload = { "definition": {
"trigger": {
"inputs": [
{
"key": "<string>",
"label": "<string>",
"required": True
}
],
"event": "<string>",
"schedule": {
"time": "<string>",
"weekday": 4,
"day": 16,
"timezone": "<string>"
}
},
"conditions": { "rules": [
{
"field": "<string>",
"value": "<string>"
}
] },
"steps": [
{
"key": "<string>",
"action": "<string>",
"inputs": [
{
"input": "<string>",
"value": "<string>",
"step": "<string>",
"field": "<string>"
}
],
"code": { "source": "<string>" }
}
]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stockshift.io/api/v1/automation/automations/{automation}/draft",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'definition' => [
'trigger' => [
'inputs' => [
[
'key' => '<string>',
'label' => '<string>',
'required' => true
]
],
'event' => '<string>',
'schedule' => [
'time' => '<string>',
'weekday' => 4,
'day' => 16,
'timezone' => '<string>'
]
],
'conditions' => [
'rules' => [
[
'field' => '<string>',
'value' => '<string>'
]
]
],
'steps' => [
[
'key' => '<string>',
'action' => '<string>',
'inputs' => [
[
'input' => '<string>',
'value' => '<string>',
'step' => '<string>',
'field' => '<string>'
]
],
'code' => [
'source' => '<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://app.stockshift.io/api/v1/automation/automations/{automation}/draft"
payload := strings.NewReader("{\n \"definition\": {\n \"trigger\": {\n \"inputs\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true\n }\n ],\n \"event\": \"<string>\",\n \"schedule\": {\n \"time\": \"<string>\",\n \"weekday\": 4,\n \"day\": 16,\n \"timezone\": \"<string>\"\n }\n },\n \"conditions\": {\n \"rules\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"steps\": [\n {\n \"key\": \"<string>\",\n \"action\": \"<string>\",\n \"inputs\": [\n {\n \"input\": \"<string>\",\n \"value\": \"<string>\",\n \"step\": \"<string>\",\n \"field\": \"<string>\"\n }\n ],\n \"code\": {\n \"source\": \"<string>\"\n }\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}{
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"enabled": true,
"archived": true,
"current_version": 123,
"has_draft": true,
"draft_saved_at": "<string>",
"definition": {
"trigger": {
"type": "manual",
"inputs": [
"<unknown>"
],
"event": "<string>",
"schedule": {
"frequency": "every_15_minutes",
"time": "<string>",
"weekday": 123,
"day": 123,
"timezone": "<string>"
}
},
"conditions": {
"match": "all",
"rules": [
"<unknown>"
]
},
"steps": [
"<unknown>"
]
},
"problems": [
{
"step": 123,
"input": "<string>",
"message": "<string>"
}
],
"versions": [
{
"number": 123,
"current": true,
"copied_from": 123,
"published_by": "<string>",
"published_at": "<string>"
}
],
"can_manage": true,
"can_publish": true,
"attention": "<string>",
"skipped_runs": 123,
"can_start": true,
"run_inputs": [
"<unknown>"
],
"secret_steps": [
"<string>"
],
"members": [
{
"id": 123,
"name": "<string>"
}
],
"roles": [
"<string>"
],
"not_started": "<string>",
"not_started_at": "<string>",
"waiting_triggers": 123,
"runs_per_minute": 123,
"next_run_at": "<string>",
"default_timezone": "<string>",
"template_key": "<string>",
"template_version": 123
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}Authorizations
apiKeyoauth2
For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.
Path Parameters
Body
application/json
An automation's definition to keep as its draft: a trigger, conditions, ordered steps and a code step's code. Each step input is mapped to a fixed value, a value of the trigger's data or an earlier step's output. A script is never taken from a draft; it is made when the version is published.
Show child attributes
Show child attributes
Response
AutomationResource
Show child attributes
Show child attributes
Was this page helpful?