GET
/
v2
/
workspaces
/
{workspaceId}
/
automations
/
{automationSlug}
curl --request GET \
  --url https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/automations/{automationSlug} \
  --header 'X-Prismeai-API-Key: <api-key>'
{
  "description": {
    "fr": "Bonjour",
    "en": "Hello"
  },
  "private": false,
  "disabled": true,
  "name": {
    "fr": "Bonjour",
    "en": "Hello"
  },
  "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>",
  "do": [
    {
      "emit": {
        "event": "prismeaiMessenger.message",
        "payload": "<any>",
        "target": {
          "userTopic": "<string>",
          "userId": "<string>",
          "sessionId": "<string>",
          "currentSocket": true
        },
        "private": true,
        "autocomplete": {},
        "options": {
          "persist": true,
          "aggPayload": true
        }
      }
    }
  ],
  "output": "<any>",
  "authorizations": {
    "action": "<string>"
  }
}

Authorizations

​
X-Prismeai-API-Key
string
header
required
​
connect.sid
string
cookie
required

Path Parameters

​
workspaceId
string
required

Workspace id

​
automationSlug
string
required

Automation slug

Response

200
application/json
Success Response
​
name
required
Example:
{ "fr": "Bonjour", "en": "Hello" }
​
do
object[]
required
​
description
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
​
validateArguments
boolean
​
when
object
​
labels
string[]
​
events
object
​
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 ...

​
authorizations
object

Was this page helpful?

Raise issue