Post v2workspaces automations

Create a new automation

POST /v2/workspaces/{workspaceId}/automations

cURL

cURL

curl --request POST \
  --url https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/automations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": {
    "fr": "Bonjour",
    "en": "Hello"
  },
  "do": [
    {
      "emit": {
        "event": "prismeaiMessenger.message",
        "payload": "<unknown>",
        "target": {
          "userTopic": "<string>",
          "userId": "<string>",
          "sessionId": "<string>",
          "currentSocket": true
        },
        "private": true,
        "autocomplete": {},
        "options": {
          "persist": true,
          "aggPayload": false,
          "async": false
        }
      }
    }
  ],
  "description": {
    "fr": "Bonjour",
    "en": "Hello"
  },
  "private": false,
  "disabled": true,
  "slug": "<string>",
  "arguments": {},
  "validateArguments": true,
  "when": {
    "events": [
      "prismeaiMessenger.event"
    ],
    "schedules": [
      "2021-12-25T00:00",
      "* * 1 * *"
    ],
    "endpoint": "Set to true in order to activate HTTP endpoint. Slug will be trigger name by default"
  },
  "labels": [
    "<string>"
  ],
  "events": {
    "emit": [
      "<string>"
    ],
    "listen": [
      "<string>"
    ],
    "autocomplete": [
      {
        "event": "prismeaiMessenger.message",
        "autocomplete": {}
      }
    ]
  },
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "updatedBy": "<string>",
  "createdBy": "<string>",
  "checksum": "<string>",
  "output": "{{result}}",
  "authorizations": {
    "action": "<string>"
  }
}
'

import requests

url = "https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/automations"

payload = {
    "name": {
        "fr": "Bonjour",
        "en": "Hello"
    },
    "do": [{ "emit": {
                "event": "prismeaiMessenger.message",
                "payload": "<unknown>",
                "target": {
                    "userTopic": "<string>",
                    "userId": "<string>",
                    "sessionId": "<string>",
                    "currentSocket": True
                },
                "private": True,
                "autocomplete": {},
                "options": {
                    "persist": True,
                    "aggPayload": False,
                    "async": False
                }
            } }],
    "description": {
        "fr": "Bonjour",
        "en": "Hello"
    },
    "private": False,
    "disabled": True,
    "slug": "<string>",
    "arguments": {},
    "validateArguments": True,
    "when": {
        "events": ["prismeaiMessenger.event"],
        "schedules": ["2021-12-25T00:00", "* * 1 * *"],
        "endpoint": "Set to true in order to activate HTTP endpoint. Slug will be trigger name by default"
    },
    "labels": ["<string>"],
    "events": {
        "emit": ["<string>"],
        "listen": ["<string>"],
        "autocomplete": [
            {
                "event": "prismeaiMessenger.message",
                "autocomplete": {}
            }
        ]
    },
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "updatedBy": "<string>",
    "createdBy": "<string>",
    "checksum": "<string>",
    "output": "{{result}}",
    "authorizations": { "action": "<string>" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: {fr: 'Bonjour', en: 'Hello'},
    do: [
      {
        emit: {
          event: 'prismeaiMessenger.message',
          payload: '<unknown>',
          target: {
            userTopic: '<string>',
            userId: '<string>',
            sessionId: '<string>',
            currentSocket: true
          },
          private: true,
          autocomplete: {},
          options: {persist: true, aggPayload: false, async: false}
        }
      }
    ],
    description: {fr: 'Bonjour', en: 'Hello'},
    private: false,
    disabled: true,
    slug: '<string>',
    arguments: {},
    validateArguments: true,
    when: {
      events: ['prismeaiMessenger.event'],
      schedules: ['2021-12-25T00:00', '* * 1 * *'],
      endpoint: 'Set to true in order to activate HTTP endpoint. Slug will be trigger name by default'
    },
    labels: ['<string>'],
    events: {
      emit: ['<string>'],
      listen: ['<string>'],
      autocomplete: [{event: 'prismeaiMessenger.message', autocomplete: {}}]
    },
    updatedAt: '<string>',
    createdAt: '<string>',
    updatedBy: '<string>',
    createdBy: '<string>',
    checksum: '<string>',
    output: '{{result}}',
    authorizations: {action: '<string>'}
  })
};

fetch('https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/automations', 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.eda.prisme.ai/v2/workspaces/{workspaceId}/automations",
  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' => [
        'fr' => 'Bonjour',
        'en' => 'Hello'
    ],
    'do' => [
        [
                'emit' => [
                                'event' => 'prismeaiMessenger.message',
                                'payload' => '<unknown>',
                                'target' => [
                                                                'userTopic' => '<string>',
                                                                'userId' => '<string>',
                                                                'sessionId' => '<string>',
                                                                'currentSocket' => true
                                ],
                                'private' => true,
                                'autocomplete' => [
                                                                
                                ],
                                'options' => [
                                                                'persist' => true,
                                                                'aggPayload' => false,
                                                                'async' => false
                                ]
                ]
        ]
    ],
    'description' => [
        'fr' => 'Bonjour',
        'en' => 'Hello'
    ],
    'private' => false,
    'disabled' => true,
    'slug' => '<string>',
    'arguments' => [
        
    ],
    'validateArguments' => true,
    'when' => [
        'events' => [
                'prismeaiMessenger.event'
        ],
        'schedules' => [
                '2021-12-25T00:00',
                '* * 1 * *'
        ],
        'endpoint' => 'Set to true in order to activate HTTP endpoint. Slug will be trigger name by default'
    ],
    'labels' => [
        '<string>'
    ],
    'events' => [
        'emit' => [
                '<string>'
        ],
        'listen' => [
                '<string>'
        ],
        'autocomplete' => [
                [
                                'event' => 'prismeaiMessenger.message',
                                'autocomplete' => [
                                                                
                                ]
                ]
        ]
    ],
    'updatedAt' => '<string>',
    'createdAt' => '<string>',
    'updatedBy' => '<string>',
    'createdBy' => '<string>',
    'checksum' => '<string>',
    'output' => '{{result}}',
    'authorizations' => [
        'action' => '<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://api.eda.prisme.ai/v2/workspaces/{workspaceId}/automations"

	payload := strings.NewReader("{\n  \"name\": {\n    \"fr\": \"Bonjour\",\n    \"en\": \"Hello\"\n  },\n  \"do\": [\n    {\n      \"emit\": {\n        \"event\": \"prismeaiMessenger.message\",\n        \"payload\": \"<unknown>\",\n        \"target\": {\n          \"userTopic\": \"<string>\",\n          \"userId\": \"<string>\",\n          \"sessionId\": \"<string>\",\n          \"currentSocket\": true\n        },\n        \"private\": true,\n        \"autocomplete\": {},\n        \"options\": {\n          \"persist\": true,\n          \"aggPayload\": false,\n          \"async\": false\n        }\n      }\n    }\n  ],\n  \"description\": {\n    \"fr\": \"Bonjour\",\n    \"en\": \"Hello\"\n  },\n  \"private\": false,\n  \"disabled\": true,\n  \"slug\": \"<string>\",\n  \"arguments\": {},\n  \"validateArguments\": true,\n  \"when\": {\n    \"events\": [\n      \"prismeaiMessenger.event\"\n    ],\n    \"schedules\": [\n      \"2021-12-25T00:00\",\n      \"* * 1 * *\"\n    ],\n    \"endpoint\": \"Set to true in order to activate HTTP endpoint. Slug will be trigger name by default\"\n  },\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"events\": {\n    \"emit\": [\n      \"<string>\"\n    ],\n    \"listen\": [\n      \"<string>\"\n    ],\n    \"autocomplete\": [\n      {\n        \"event\": \"prismeaiMessenger.message\",\n        \"autocomplete\": {}\n      }\n    ]\n  },\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"createdBy\": \"<string>\",\n  \"checksum\": \"<string>\",\n  \"output\": \"{{result}}\",\n  \"authorizations\": {\n    \"action\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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))

}

HttpResponse<String> response = Unirest.post("https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/automations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": {\n    \"fr\": \"Bonjour\",\n    \"en\": \"Hello\"\n  },\n  \"do\": [\n    {\n      \"emit\": {\n        \"event\": \"prismeaiMessenger.message\",\n        \"payload\": \"<unknown>\",\n        \"target\": {\n          \"userTopic\": \"<string>\",\n          \"userId\": \"<string>\",\n          \"sessionId\": \"<string>\",\n          \"currentSocket\": true\n        },\n        \"private\": true,\n        \"autocomplete\": {},\n        \"options\": {\n          \"persist\": true,\n          \"aggPayload\": false,\n          \"async\": false\n        }\n      }\n    }\n  ],\n  \"description\": {\n    \"fr\": \"Bonjour\",\n    \"en\": \"Hello\"\n  },\n  \"private\": false,\n  \"disabled\": true,\n  \"slug\": \"<string>\",\n  \"arguments\": {},\n  \"validateArguments\": true,\n  \"when\": {\n    \"events\": [\n      \"prismeaiMessenger.event\"\n    ],\n    \"schedules\": [\n      \"2021-12-25T00:00\",\n      \"* * 1 * *\"\n    ],\n    \"endpoint\": \"Set to true in order to activate HTTP endpoint. Slug will be trigger name by default\"\n  },\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"events\": {\n    \"emit\": [\n      \"<string>\"\n    ],\n    \"listen\": [\n      \"<string>\"\n    ],\n    \"autocomplete\": [\n      {\n        \"event\": \"prismeaiMessenger.message\",\n        \"autocomplete\": {}\n      }\n    ]\n  },\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"createdBy\": \"<string>\",\n  \"checksum\": \"<string>\",\n  \"output\": \"{{result}}\",\n  \"authorizations\": {\n    \"action\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/automations")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": {\n    \"fr\": \"Bonjour\",\n    \"en\": \"Hello\"\n  },\n  \"do\": [\n    {\n      \"emit\": {\n        \"event\": \"prismeaiMessenger.message\",\n        \"payload\": \"<unknown>\",\n        \"target\": {\n          \"userTopic\": \"<string>\",\n          \"userId\": \"<string>\",\n          \"sessionId\": \"<string>\",\n          \"currentSocket\": true\n        },\n        \"private\": true,\n        \"autocomplete\": {},\n        \"options\": {\n          \"persist\": true,\n          \"aggPayload\": false,\n          \"async\": false\n        }\n      }\n    }\n  ],\n  \"description\": {\n    \"fr\": \"Bonjour\",\n    \"en\": \"Hello\"\n  },\n  \"private\": false,\n  \"disabled\": true,\n  \"slug\": \"<string>\",\n  \"arguments\": {},\n  \"validateArguments\": true,\n  \"when\": {\n    \"events\": [\n      \"prismeaiMessenger.event\"\n    ],\n    \"schedules\": [\n      \"2021-12-25T00:00\",\n      \"* * 1 * *\"\n    ],\n    \"endpoint\": \"Set to true in order to activate HTTP endpoint. Slug will be trigger name by default\"\n  },\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"events\": {\n    \"emit\": [\n      \"<string>\"\n    ],\n    \"listen\": [\n      \"<string>\"\n    ],\n    \"autocomplete\": [\n      {\n        \"event\": \"prismeaiMessenger.message\",\n        \"autocomplete\": {}\n      }\n    ]\n  },\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"createdBy\": \"<string>\",\n  \"checksum\": \"<string>\",\n  \"output\": \"{{result}}\",\n  \"authorizations\": {\n    \"action\": \"<string>\"\n  }\n}"

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

200

{
  "name": {
    "fr": "Bonjour",
    "en": "Hello"
  },
  "do": [
    {
      "emit": {
        "event": "prismeaiMessenger.message",
        "payload": "<unknown>",
        "target": {
          "userTopic": "<string>",
          "userId": "<string>",
          "sessionId": "<string>",
          "currentSocket": true
        },
        "private": true,
        "autocomplete": {},
        "options": {
          "persist": true,
          "aggPayload": false,
          "async": false
        }
      }
    }
  ],
  "description": {
    "fr": "Bonjour",
    "en": "Hello"
  },
  "private": false,
  "disabled": true,
  "slug": "<string>",
  "arguments": {},
  "validateArguments": true,
  "when": {
    "events": [
      "prismeaiMessenger.event"
    ],
    "schedules": [
      "2021-12-25T00:00",
      "* * 1 * *"
    ],
    "endpoint": "Set to true in order to activate HTTP endpoint. Slug will be trigger name by default"
  },
  "labels": [
    "<string>"
  ],
  "events": {
    "emit": [
      "<string>"
    ],
    "listen": [
      "<string>"
    ],
    "autocomplete": [
      {
        "event": "prismeaiMessenger.message",
        "autocomplete": {}
      }
    ]
  },
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "updatedBy": "<string>",
  "createdBy": "<string>",
  "checksum": "<string>",
  "output": "{{result}}",
  "authorizations": {
    "action": "<string>"
  }
}

{
  "error": "BadParameters",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": "AuthenticationError",
  "message": "Unauthenticated"
}

{
  "error": "ForbiddenError",
  "message": "Forbidden"
}

{
  "error": "ObjectNotFound",
  "message": "<string>"
}

Authorizations

BearerAuthWorkspaceApiKeyAuthBearerAuth & WorkspaceApiKeyAuth

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId · string · required

Workspace id

Body

application/json

name · object string · required

Show child attributes

Example:

{ "fr": "Bonjour", "en": "Hello" }

do · object[] · required

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Show child attributes

description · object string

Show child attributes

Example:

{ "fr": "Bonjour", "en": "Hello" }

private · boolean

Set this to true if you don't want your automation to be accessible outside of your app. Default is false.

Example:

false

disabled · boolean

Set this to true if you want to turn off this automation.

Example:

true

slug · string

Unique & human readable id across current workspace's automations

arguments · object

Show child attributes

validateArguments · boolean

when · object

Option 1

Option 2

Option 3

Option 4

Show child attributes

labels · string[]

Pattern: ^[0-9A-Za-z._:-]{2,60}$

events · object

Show child attributes

updatedAt · string

createdAt · string

updatedBy · string

createdBy · string

checksum · string

output · any

Automation result expression. Might be a variable reference, an object/array with variables inside ...

Example:

"{{result}}"

authorizations · object

Show child attributes

Response

200

application/json

Success Response

name · object string · required

Show child attributes

Example:

{ "fr": "Bonjour", "en": "Hello" }

do · object[] · required

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Show child attributes

description · object string

Show child attributes

Example:

{ "fr": "Bonjour", "en": "Hello" }

private · boolean

Set this to true if you don't want your automation to be accessible outside of your app. Default is false.

Example:

false

disabled · boolean

Set this to true if you want to turn off this automation.

Example:

true

slug · string

Unique & human readable id across current workspace's automations

arguments · object

Show child attributes

validateArguments · boolean

when · object

Option 1

Option 2

Option 3

Option 4

Show child attributes

labels · string[]

Pattern: ^[0-9A-Za-z._:-]{2,60}$

events · object

Show child attributes

updatedAt · string

createdAt · string

updatedBy · string

createdBy · string

checksum · string

output · any

Automation result expression. Might be a variable reference, an object/array with variables inside ...

Example:

"{{result}}"

authorizations · object

Show child attributes