Patch v2workspaces automations

cURL

curl --request PATCH \
  --url https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/automations/{automationSlug} \
  --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>"
  }
}
'

{
  "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>"
  }
}

PATCH

workspaces

{workspaceId}

automations

{automationSlug}

cURL

curl --request PATCH \
  --url https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/automations/{automationSlug} \
  --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>"
  }
}
'

{
  "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>"
  }
}

Authorizations

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

automationSlug

string

required

Automation slug

Body

application/json

name

required

Show child attributes

name.{key}

string

Example:

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

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

Show child attributes

do.emit

object

required

Show child attributes

do.emit.event

string

required

Example:

"prismeaiMessenger.message"

do.emit.payload

any

do.emit.target

object

Show child attributes

do.emit.target.userTopic

string

do.emit.target.userId

string

do.emit.target.sessionId

string

do.emit.target.currentSocket

boolean

default:true

If emitted in response to an active socket (i.e source.socketId is set), this event is only visible to this same socket. Defaults to true

do.emit.private

boolean

do.emit.autocomplete

object

Show child attributes

do.emit.autocomplete.{key}

object

Show child attributes

do.emit.autocomplete.{key}.from

string

do.emit.autocomplete.{key}.path

string

do.emit.autocomplete.{key}.template

string

do.emit.options

object

Show child attributes

do.emit.options.persist

boolean

default:true

Whether to persist this event or not. Defaults to true

do.emit.options.aggPayload

boolean

default:false

Populate advanced aggregation payload for custom mappings & analytics. This is automatically enabled for events mapped in config.events.types.*

do.emit.options.async

boolean

default:false

If true, the instruction will return control without waiting for the event to be emitted. Defaults to false

description

Show child attributes

description.{key}

string

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

arguments.{key}

object

Show child attributes

arguments.{key}.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

arguments.{key}.format

string

arguments.{key}.properties

object

Show child attributes

arguments.{key}.properties.{key}

object

Show child attributes

arguments.{key}.title

Show child attributes

arguments.{key}.title.{key}

string

Example:

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

arguments.{key}.description

Show child attributes

arguments.{key}.description.{key}

string

Example:

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

arguments.{key}.items

any

arguments.{key}.ui:widget

string

arguments.{key}.ui:options

object

arguments.{key}.secret

boolean

arguments.{key}.event

boolean

validateArguments

boolean

when

object

Option 1
Option 2
Option 3
Option 4

Show child attributes

when.events

string[]

required

Example:

["prismeaiMessenger.event"]

when.schedules

string[]

Example:

["2021-12-25T00:00", "* * 1 * *"]

when.endpoint

Example:

"Set to true in order to activate HTTP endpoint. Slug will be trigger name by default"

labels

string[]

events

object

Show child attributes

events.emit

string[]

events.listen

string[]

events.autocomplete

object[]

Show child attributes

events.autocomplete.event

string

required

Example:

"prismeaiMessenger.message"

events.autocomplete.autocomplete

object

Show child attributes

events.autocomplete.autocomplete.{key}

object

Show child attributes

events.autocomplete.autocomplete.{key}.from

string

events.autocomplete.autocomplete.{key}.path

string

events.autocomplete.autocomplete.{key}.template

string

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

authorizations.action

string

Response

Success Response

name

required

Show child attributes

name.{key}

string

Example:

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

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

Show child attributes

do.emit

object

required

Show child attributes

do.emit.event

string

required

Example:

"prismeaiMessenger.message"

do.emit.payload

any

do.emit.target

object

Show child attributes

do.emit.target.userTopic

string

do.emit.target.userId

string

do.emit.target.sessionId

string

do.emit.target.currentSocket

boolean

default:true

If emitted in response to an active socket (i.e source.socketId is set), this event is only visible to this same socket. Defaults to true

do.emit.private

boolean

do.emit.autocomplete

object

Show child attributes

do.emit.autocomplete.{key}

object

Show child attributes

do.emit.autocomplete.{key}.from

string

do.emit.autocomplete.{key}.path

string

do.emit.autocomplete.{key}.template

string

do.emit.options

object

Show child attributes

do.emit.options.persist

boolean

default:true

Whether to persist this event or not. Defaults to true

do.emit.options.aggPayload

boolean

default:false

Populate advanced aggregation payload for custom mappings & analytics. This is automatically enabled for events mapped in config.events.types.*

do.emit.options.async

boolean

default:false

If true, the instruction will return control without waiting for the event to be emitted. Defaults to false

description

Show child attributes

description.{key}

string

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

arguments.{key}

object

Show child attributes

arguments.{key}.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

arguments.{key}.format

string

arguments.{key}.properties

object

Show child attributes

arguments.{key}.properties.{key}

object

Show child attributes

arguments.{key}.title

Show child attributes

arguments.{key}.title.{key}

string

Example:

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

arguments.{key}.description

Show child attributes

arguments.{key}.description.{key}

string

Example:

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

arguments.{key}.items

any

arguments.{key}.ui:widget

string

arguments.{key}.ui:options

object

arguments.{key}.secret

boolean

arguments.{key}.event

boolean

validateArguments

boolean

when

object

Option 1
Option 2
Option 3
Option 4

Show child attributes

when.events

string[]

required

Example:

["prismeaiMessenger.event"]

when.schedules

string[]

Example:

["2021-12-25T00:00", "* * 1 * *"]

when.endpoint

Example:

"Set to true in order to activate HTTP endpoint. Slug will be trigger name by default"

labels

string[]

events

object

Show child attributes

events.emit

string[]

events.listen

string[]

events.autocomplete

object[]

Show child attributes

events.autocomplete.event

string

required

Example:

"prismeaiMessenger.message"

events.autocomplete.autocomplete

object

Show child attributes

events.autocomplete.autocomplete.{key}

object

Show child attributes

events.autocomplete.autocomplete.{key}.from

string

events.autocomplete.autocomplete.{key}.path

string

events.autocomplete.autocomplete.{key}.template

string

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

authorizations.action

string

Delete v2workspaces automations Post v2workspaces test

⌘I

Introduction

AI Builder Endpoints

Patch v2workspaces automations

Authorizations

Path Parameters

Body

Response