Create workflow resource

curl --request POST \
  --url https://api.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/workflows \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "entryNodeId": "x",
  "nodes": [
    {
      "id": "x",
      "position": [
        0,
        0
      ],
      "type": "amply",
      "config": {
        "operation": {
          "type": "string",
          "value": "string"
        },
        "resource": {
          "type": "string",
          "value": "string"
        }
      }
    }
  ],
  "name": "x"
}
'

import requests

url = "https://api.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/workflows"

payload = {
    "entryNodeId": "x",
    "nodes": [
        {
            "id": "x",
            "position": [0, 0],
            "type": "amply",
            "config": {
                "operation": {
                    "type": "string",
                    "value": "string"
                },
                "resource": {
                    "type": "string",
                    "value": "string"
                }
            }
        }
    ],
    "name": "x"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entryNodeId: 'x',
    nodes: [
      {
        id: 'x',
        position: [0, 0],
        type: 'amply',
        config: {
          operation: {type: 'string', value: 'string'},
          resource: {type: 'string', value: 'string'}
        }
      }
    ],
    name: 'x'
  })
};

fetch('https://api.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/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.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/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([
    'entryNodeId' => 'x',
    'nodes' => [
        [
                'id' => 'x',
                'position' => [
                                0,
                                0
                ],
                'type' => 'amply',
                'config' => [
                                'operation' => [
                                                                'type' => 'string',
                                                                'value' => 'string'
                                ],
                                'resource' => [
                                                                'type' => 'string',
                                                                'value' => 'string'
                                ]
                ]
        ]
    ],
    'name' => 'x'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/workflows"

	payload := strings.NewReader("{\n  \"entryNodeId\": \"x\",\n  \"nodes\": [\n    {\n      \"id\": \"x\",\n      \"position\": [\n        0,\n        0\n      ],\n      \"type\": \"amply\",\n      \"config\": {\n        \"operation\": {\n          \"type\": \"string\",\n          \"value\": \"string\"\n        },\n        \"resource\": {\n          \"type\": \"string\",\n          \"value\": \"string\"\n        }\n      }\n    }\n  ],\n  \"name\": \"x\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	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.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/workflows")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entryNodeId\": \"x\",\n  \"nodes\": [\n    {\n      \"id\": \"x\",\n      \"position\": [\n        0,\n        0\n      ],\n      \"type\": \"amply\",\n      \"config\": {\n        \"operation\": {\n          \"type\": \"string\",\n          \"value\": \"string\"\n        },\n        \"resource\": {\n          \"type\": \"string\",\n          \"value\": \"string\"\n        }\n      }\n    }\n  ],\n  \"name\": \"x\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/workflows")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entryNodeId\": \"x\",\n  \"nodes\": [\n    {\n      \"id\": \"x\",\n      \"position\": [\n        0,\n        0\n      ],\n      \"type\": \"amply\",\n      \"config\": {\n        \"operation\": {\n          \"type\": \"string\",\n          \"value\": \"string\"\n        },\n        \"resource\": {\n          \"type\": \"string\",\n          \"value\": \"string\"\n        }\n      }\n    }\n  ],\n  \"name\": \"x\"\n}"

response = http.request(request)
puts response.read_body

{
  "entryNodeId": "x",
  "nodes": [
    {
      "id": "x",
      "position": [
        0
      ],
      "type": "amply",
      "config": {
        "operation": {
          "type": "string",
          "value": "string",
          "useExpression": true,
          "expression": "string"
        },
        "resource": {
          "type": "string",
          "value": "string",
          "useExpression": true,
          "expression": "string"
        },
        "id": {
          "type": "string",
          "value": "string",
          "useExpression": true,
          "expression": "string"
        },
        "metadata": {
          "filters": {
            "type": "object",
            "value": [
              {
                "key": {
                  "type": "string",
                  "value": "string",
                  "useExpression": true,
                  "expression": "string"
                },
                "value": {
                  "type": "string",
                  "value": "string",
                  "useExpression": true,
                  "expression": "string"
                }
              }
            ],
            "useExpression": true,
            "expression": "string"
          },
          "filtersLogical": {
            "type": "enum",
            "value": "$and",
            "useExpression": true,
            "expression": "string"
          },
          "preview": true,
          "cursors": {
            "limit": {
              "type": "number",
              "value": 0,
              "useExpression": true,
              "expression": "string"
            },
            "skip": {
              "type": "number",
              "value": 0,
              "useExpression": true,
              "expression": "string"
            },
            "sort": {},
            "startId": {
              "type": "string",
              "value": "string",
              "useExpression": true,
              "expression": "string"
            }
          }
        },
        "body": {
          "type": "object",
          "value": [
            {
              "key": {
                "type": "string",
                "value": "string",
                "useExpression": true,
                "expression": "string"
              },
              "value": {
                "type": "string",
                "value": "string",
                "useExpression": true,
                "expression": "string"
              }
            }
          ],
          "useExpression": true,
          "expression": "string"
        }
      },
      "name": "x",
      "errorBehavior": "stopWorkflow",
      "onSuccess": "x",
      "onError": "x"
    }
  ],
  "name": "x",
  "_id": "64b7f8b6f23a4a4f3d0a9b12",
  "_createdAt": "2024-01-01T00:00:00.000Z",
  "description": "string",
  "status": "enabled",
  "trigger": {
    "type": "manual"
  },
  "metadata": {},
  "_updatedAt": "2024-01-01T00:00:00.000Z",
  "_reference": "string"
}

POST

users

{userId}

broadcasts

{broadcastId}

workflows

Create workflow resource

curl --request POST \
  --url https://api.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/workflows \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "entryNodeId": "x",
  "nodes": [
    {
      "id": "x",
      "position": [
        0,
        0
      ],
      "type": "amply",
      "config": {
        "operation": {
          "type": "string",
          "value": "string"
        },
        "resource": {
          "type": "string",
          "value": "string"
        }
      }
    }
  ],
  "name": "x"
}
'

import requests

url = "https://api.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/workflows"

payload = {
    "entryNodeId": "x",
    "nodes": [
        {
            "id": "x",
            "position": [0, 0],
            "type": "amply",
            "config": {
                "operation": {
                    "type": "string",
                    "value": "string"
                },
                "resource": {
                    "type": "string",
                    "value": "string"
                }
            }
        }
    ],
    "name": "x"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entryNodeId: 'x',
    nodes: [
      {
        id: 'x',
        position: [0, 0],
        type: 'amply',
        config: {
          operation: {type: 'string', value: 'string'},
          resource: {type: 'string', value: 'string'}
        }
      }
    ],
    name: 'x'
  })
};

fetch('https://api.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/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.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/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([
    'entryNodeId' => 'x',
    'nodes' => [
        [
                'id' => 'x',
                'position' => [
                                0,
                                0
                ],
                'type' => 'amply',
                'config' => [
                                'operation' => [
                                                                'type' => 'string',
                                                                'value' => 'string'
                                ],
                                'resource' => [
                                                                'type' => 'string',
                                                                'value' => 'string'
                                ]
                ]
        ]
    ],
    'name' => 'x'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/workflows"

	payload := strings.NewReader("{\n  \"entryNodeId\": \"x\",\n  \"nodes\": [\n    {\n      \"id\": \"x\",\n      \"position\": [\n        0,\n        0\n      ],\n      \"type\": \"amply\",\n      \"config\": {\n        \"operation\": {\n          \"type\": \"string\",\n          \"value\": \"string\"\n        },\n        \"resource\": {\n          \"type\": \"string\",\n          \"value\": \"string\"\n        }\n      }\n    }\n  ],\n  \"name\": \"x\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	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.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/workflows")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entryNodeId\": \"x\",\n  \"nodes\": [\n    {\n      \"id\": \"x\",\n      \"position\": [\n        0,\n        0\n      ],\n      \"type\": \"amply\",\n      \"config\": {\n        \"operation\": {\n          \"type\": \"string\",\n          \"value\": \"string\"\n        },\n        \"resource\": {\n          \"type\": \"string\",\n          \"value\": \"string\"\n        }\n      }\n    }\n  ],\n  \"name\": \"x\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/workflows")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entryNodeId\": \"x\",\n  \"nodes\": [\n    {\n      \"id\": \"x\",\n      \"position\": [\n        0,\n        0\n      ],\n      \"type\": \"amply\",\n      \"config\": {\n        \"operation\": {\n          \"type\": \"string\",\n          \"value\": \"string\"\n        },\n        \"resource\": {\n          \"type\": \"string\",\n          \"value\": \"string\"\n        }\n      }\n    }\n  ],\n  \"name\": \"x\"\n}"

response = http.request(request)
puts response.read_body

{
  "entryNodeId": "x",
  "nodes": [
    {
      "id": "x",
      "position": [
        0
      ],
      "type": "amply",
      "config": {
        "operation": {
          "type": "string",
          "value": "string",
          "useExpression": true,
          "expression": "string"
        },
        "resource": {
          "type": "string",
          "value": "string",
          "useExpression": true,
          "expression": "string"
        },
        "id": {
          "type": "string",
          "value": "string",
          "useExpression": true,
          "expression": "string"
        },
        "metadata": {
          "filters": {
            "type": "object",
            "value": [
              {
                "key": {
                  "type": "string",
                  "value": "string",
                  "useExpression": true,
                  "expression": "string"
                },
                "value": {
                  "type": "string",
                  "value": "string",
                  "useExpression": true,
                  "expression": "string"
                }
              }
            ],
            "useExpression": true,
            "expression": "string"
          },
          "filtersLogical": {
            "type": "enum",
            "value": "$and",
            "useExpression": true,
            "expression": "string"
          },
          "preview": true,
          "cursors": {
            "limit": {
              "type": "number",
              "value": 0,
              "useExpression": true,
              "expression": "string"
            },
            "skip": {
              "type": "number",
              "value": 0,
              "useExpression": true,
              "expression": "string"
            },
            "sort": {},
            "startId": {
              "type": "string",
              "value": "string",
              "useExpression": true,
              "expression": "string"
            }
          }
        },
        "body": {
          "type": "object",
          "value": [
            {
              "key": {
                "type": "string",
                "value": "string",
                "useExpression": true,
                "expression": "string"
              },
              "value": {
                "type": "string",
                "value": "string",
                "useExpression": true,
                "expression": "string"
              }
            }
          ],
          "useExpression": true,
          "expression": "string"
        }
      },
      "name": "x",
      "errorBehavior": "stopWorkflow",
      "onSuccess": "x",
      "onError": "x"
    }
  ],
  "name": "x",
  "_id": "64b7f8b6f23a4a4f3d0a9b12",
  "_createdAt": "2024-01-01T00:00:00.000Z",
  "description": "string",
  "status": "enabled",
  "trigger": {
    "type": "manual"
  },
  "metadata": {},
  "_updatedAt": "2024-01-01T00:00:00.000Z",
  "_reference": "string"
}

Authorizations

X-API-KEY

string

header

required

Use the format X-API-KEY YOUR_API_KEY. Each key is tied to a single broadcast.

Path Parameters

userId

string<objectId>

required

Resource identifier.

broadcastId

string<objectId>

required

Resource identifier.

Body

application/json

entryNodeId

string

required

Minimum string length: 1

Example:

"x"

nodes

required

Définition des nodes du workflow. Chaque node possède: id, position [x,y], type, config, onSuccess, onError. Les variables runtime des code nodes sont documentées dans config.code.

Show child attributes

name

string

required

Minimum string length: 1

Example:

"x"

description

string

Example:

"string"

status

enum<string>

Available options:

enabled,

disabled

Example:

"enabled"

trigger

manual · object

manual
interval
schedule
once

Show child attributes

metadata

object

Show child attributes

Response

201 - application/json

Success

entryNodeId

string

required

Minimum string length: 1

Example:

"x"

nodes

required

Définition des nodes du workflow. Chaque node possède: id, position [x,y], type, config, onSuccess, onError. Les variables runtime des code nodes sont documentées dans config.code.

Show child attributes

name

string

required

Minimum string length: 1

Example:

"x"

_id

string<objectId>

required

Example:

"64b7f8b6f23a4a4f3d0a9b12"

_createdAt

string<date-time>

required

Example:

"2024-01-01T00:00:00.000Z"

description

string

Example:

"string"

status

enum<string>

Available options:

enabled,

disabled

Example:

"enabled"

trigger

manual · object

manual
interval
schedule
once

Show child attributes

metadata

object

Show child attributes

_updatedAt

string<date-time> | null

Example:

"2024-01-01T00:00:00.000Z"

_reference

string | null

Example:

"string"

⌘I

Généralités

Ressources

broadcastEvent resource

broadcastNetworkingForm resource

media resource

broadcastContact resource

broadcastCategory resource

broadcastClient resource

broadcastDiffuser resource

broadcastCampaign resource

broadcastArticle resource

broadcast resource

broadcastHost resource

broadcastInterestPoint resource

broadcastMap resource

broadcastMember resource

broadcastPage resource

revision resource

broadcastSession resource

workflow resource

workflowRun resource

font resource

Create workflow resource

Authorizations

Path Parameters

Body

Response