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>"
]
}
]
}Automatisations
Enregistrer le brouillon d'une automatisation
Remplace la définition du brouillon, et crée un brouillon lorsque l’automatisation
n’en a pas. Une définition qui enfreint le schéma est refusée : plus d’étapes
que ne le permet le paramètre max_steps de l’organisation, une étape que le catalogue
d’étapes n’a pas ou une entrée que l’étape n’a pas. Une correspondance
qui ne convient pas à son entrée est enregistrée et listée dans problems, et le
brouillon ne peut pas être publié tant qu’elle n’est pas corrigée. Nécessite l’autorisation
automation.automations.manage et un jeton avec
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>"
]
}
]
}Autorisations
apiKeyoauth2
Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.
Paramètres de chemin
L'ID de l'automatisation, un UUID.
Corps
application/json
La définition d'une automatisation à enregistrer comme brouillon : un déclencheur, des conditions, des étapes dans l'ordre et le code d'une étape de code. Chaque entrée d'étape est associée à une valeur fixe, à une valeur des données du déclencheur ou à la sortie d'une étape précédente. Le script d'une étape de code n'est jamais tiré d'un brouillon; il est créé à la publication de la version.
Ce que fait l'automatisation : un déclencheur, des conditions et des étapes dans l'ordre.
Show child attributes
Show child attributes
Réponse
AutomationResource
Une automatisation avec son brouillon, ou la version qu'elle exécute, les problèmes qui empêchent la publication de cette définition, et ses versions.
Show child attributes
Show child attributes
Cette page vous a-t-elle été utile ?