Créer un workflow personnalisé

curl --request POST \
  --url https://partner-api.marko.fr/v1/workflows/workflow-definitions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "Run closing kickoff tasks",
  "preset_key": "closing_kickoff_tasks"
}
'

import requests

url = "https://partner-api.marko.fr/v1/workflows/workflow-definitions"

payload = {
    "name": "Run closing kickoff tasks",
    "preset_key": "closing_kickoff_tasks"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const url = 'https://partner-api.marko.fr/v1/workflows/workflow-definitions';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({name: 'Run closing kickoff tasks', preset_key: 'closing_kickoff_tasks'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({name: 'Run closing kickoff tasks', preset_key: 'closing_kickoff_tasks'})
};

fetch('https://partner-api.marko.fr/v1/workflows/workflow-definitions', 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://partner-api.marko.fr/v1/workflows/workflow-definitions",
  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' => 'Run closing kickoff tasks',
    'preset_key' => 'closing_kickoff_tasks'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "custom-workflow-1",
  "name": "Exemple MARKO",
  "description": "example",
  "type": "example",
  "schedule": "example",
  "enabled": false,
  "custom": true,
  "editable": false,
  "deletable": false,
  "toggleable": false,
  "source": "example",
  "scope": "example",
  "impact": "example",
  "job_types": [],
  "preset_key": null,
  "status": "instruction",
  "schedule_kind": null,
  "schedule_config": {},
  "config": {},
  "last_run_at": null,
  "next_run_at": null,
  "last_error": null
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Idempotency-Key must contain at most 255 visible ASCII characters without spaces.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer token is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The API key does not allow this operation.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "detail": "The idempotency key payload, external reference, target, or source conflicts with an existing write.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Unprocessable Content",
  "status": 422,
  "detail": "The request payload or parameters are invalid.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Precondition Required",
  "status": 428,
  "detail": "The Idempotency-Key header is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request rate limit was exceeded.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected server error occurred.",
  "request_id": "req_example_partner_call"
}

Authorizations

Authorization

string

header

required

Use the access_token returned by POST /v1/auth/token. Do not send the raw API secret on business endpoints.

Headers

X-Request-ID

string

Partner-generated correlation identifier echoed in logs and error payloads.

Idempotency-Key

string

required

Required for every write, including environments where replay deduplication is disabled. Reuse the same value when retrying the same logical write and use a new value for a different write.

Maximum string length: 255

Pattern: ^[!-~]+$

Body

application/json

Create one tenant-scoped custom workflow definition.

name

string

required

Nom de la ressource. Les recherches exactes et partielles sont décrites au niveau de la route.

Required string length: 1 - 200

description

string

default:""

Description libre de la ressource.

Maximum string length: 1000

preset_key

string | null

Clé du preset de workflow; utiliser une valeur du catalogue de presets.

Maximum string length: 80

schedule_kind

string | null

Mode de planification: utiliser une valeur du catalogue de presets.

Maximum string length: 20

schedule_config

Schedule Config · object

Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint.

config

Config · object

Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint.

enabled

boolean

default:true

Indique si cette définition est activée.

recommendation_id

string<uuid> | null

UUID de la recommandation persistée à l'origine de cette définition; ne pas fournir un identifiant preview.

Response

Successful response

string

required

Clé du workflow, pas nécessairement un UUID.

name

string

required

Nom de la ressource. Les recherches exactes et partielles sont décrites au niveau de la route.

description

string

required

Description libre de la ressource.

type

string

required

Famille de traitement de cette définition de workflow.

schedule

string

required

Planification actuelle du workflow.

enabled

boolean

required

Indique si cette définition est activée.

custom

boolean

required

Indique si le workflow est une définition personnalisée.

editable

boolean

required

Indique si cette définition de workflow peut être modifiée.

deletable

boolean

required

Indique si cette définition de workflow peut être supprimée.

toggleable

boolean

required

Indique si cette définition de workflow peut être activée ou désactivée.

source

string

required

Origine de cette définition de workflow; distingue les workflows système des workflows personnalisés.

scope

string

required

Périmètre métier couvert par le workflow; distinct des scopes d'autorisation de la clé API.

impact

string

required

Indication de l'effet métier attendu du preset.

job_types

string[]

required

Types de traitements associés à cette définition de workflow.

preset_key

string | null

required

Clé du preset de workflow; utiliser une valeur du catalogue de presets.

status

string

required

État de la définition de workflow: draft, active, inactive ou error. Distinct du résultat d'une exécution.

schedule_kind

string | null

required

Mode de planification: utiliser une valeur du catalogue de presets.

schedule_config

object

required

Objet JSON métier; les clés dépendent de la source ou du preset.

config

object

required

Objet JSON métier; les clés dépendent de la source ou du preset.

last_run_at

string<date-time> | null

required

Date de la dernière exécution du workflow.

next_run_at

string<date-time> | null

required

Date de la prochaine exécution planifiée, si elle existe.

last_error

string | null

required

Dernière erreur enregistrée pour cette définition de workflow.

Créer un workflow personnalisé

curl --request POST \
  --url https://partner-api.marko.fr/v1/workflows/workflow-definitions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "Run closing kickoff tasks",
  "preset_key": "closing_kickoff_tasks"
}
'

import requests

url = "https://partner-api.marko.fr/v1/workflows/workflow-definitions"

payload = {
    "name": "Run closing kickoff tasks",
    "preset_key": "closing_kickoff_tasks"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const url = 'https://partner-api.marko.fr/v1/workflows/workflow-definitions';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({name: 'Run closing kickoff tasks', preset_key: 'closing_kickoff_tasks'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({name: 'Run closing kickoff tasks', preset_key: 'closing_kickoff_tasks'})
};

fetch('https://partner-api.marko.fr/v1/workflows/workflow-definitions', 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://partner-api.marko.fr/v1/workflows/workflow-definitions",
  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' => 'Run closing kickoff tasks',
    'preset_key' => 'closing_kickoff_tasks'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "custom-workflow-1",
  "name": "Exemple MARKO",
  "description": "example",
  "type": "example",
  "schedule": "example",
  "enabled": false,
  "custom": true,
  "editable": false,
  "deletable": false,
  "toggleable": false,
  "source": "example",
  "scope": "example",
  "impact": "example",
  "job_types": [],
  "preset_key": null,
  "status": "instruction",
  "schedule_kind": null,
  "schedule_config": {},
  "config": {},
  "last_run_at": null,
  "next_run_at": null,
  "last_error": null
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Idempotency-Key must contain at most 255 visible ASCII characters without spaces.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer token is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The API key does not allow this operation.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "detail": "The idempotency key payload, external reference, target, or source conflicts with an existing write.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Unprocessable Content",
  "status": 422,
  "detail": "The request payload or parameters are invalid.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Precondition Required",
  "status": 428,
  "detail": "The Idempotency-Key header is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request rate limit was exceeded.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected server error occurred.",
  "request_id": "req_example_partner_call"
}

Démarrer

Tutoriels

Intégrer

Référence API

Créer un workflow personnalisé

Authorizations

Headers

Body

Response