Get Automation

Fetch an automation

GET /v2/workspaces/{workspaceId}/automations/{automationSlug}

Get Automation

cURL

curl --request GET \
  --url https://api.studio.prisme.ai/v2/workspaces/{workspaceId}/automations/{automationSlug} \
  --header 'Authorization: Bearer <token>'

200

{
  "slug": "send-welcome-email",
  "name": {
    "en": "Send welcome email",
    "fr": "Envoyer email de bienvenue"
  },
  "description": {
    "en": "Sends a welcome email when a user signs up"
  },
  "arguments": {
    "userId": {
      "type": "string"
    }
  },
  "do": [
    {
      "set": {
        "name": "user.welcomed",
        "value": true
      }
    },
    {
      "emit": {
        "event": "user.welcomed",
        "payload": {
          "userId": "{{userId}}"
        }
      }
    }
  ],
  "output": "{{result}}"
}

Authorizations

BearerAuthOrgApiKeyAuthBearerAuth & OrgApiKeyAuth

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

Response

200

application/json

Success Response

name · object string · required

Hide child attributes

name. {key} · string

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

Hide child attributes

do. emit · object · required

Hide child attributes

do.emit. event · string · required

Example:

"prismeaiMessenger.message"

do.emit. payload · any

do.emit. target · object

Hide 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

Hide child attributes

do.emit.autocomplete. {key} · object

Hide child attributes

do.emit.autocomplete.{key}. from · string

do.emit.autocomplete.{key}. path · string

do.emit.autocomplete.{key}. template · string

do.emit. options · object

Hide 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

Example:

[
  {
    "set": { "name": "user.welcomed", "value": true }
  },
  {
    "emit": {
      "event": "user.welcomed",
      "payload": { "userId": "{{userId}}" }
    }
  }
]

description · object string

Hide 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

Hide child attributes

arguments. {key} · object

Hide 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

Hide child attributes

arguments.{key}.properties. {key} · object

Recursive reference to TypedArgument — nesting is truncated here to avoid the infinite expansion that crashes the API reference renderer.

arguments.{key}. title · object string

Hide child attributes

arguments.{key}.title. {key} · string

Example:

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

arguments.{key}. description · object string

Hide child attributes

arguments.{key}.description. {key} · string

Example:

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

arguments.{key}. items · object

Recursive reference to TypedArgument — nesting is truncated here to avoid the infinite expansion that crashes the API reference renderer.

arguments.{key}. ui:widget · string

arguments.{key}. ui:options · object

Example:

{
  "type": "string",
  "title": { "en": "User ID" },
  "description": { "en": "The unique identifier of the user" },
  "secret": { "type": "boolean" },
  "event": { "type": "boolean" }
}

validateArguments · boolean

when · object

Option 1

Option 2

Option 3

Option 4

Hide child attributes

when. events · string[] · required

Example:

["prismeaiMessenger.event"]

when. schedules · string[]

Example:

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

when. endpoint · boolean string

Example:

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

labels · string[]

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

events · object

Hide child attributes

events. emit · string[]

events. listen · string[]

events. autocomplete · object[]

Hide child attributes

events.autocomplete. event · string · required

Example:

"prismeaiMessenger.message"

events.autocomplete. autocomplete · object

Hide child attributes

events.autocomplete.autocomplete. {key} · object

Hide 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

Hide child attributes

authorizations. action · string