Get v2workspaces automations

Fetch an automation

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

cURL

cURL

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/automations/{automationSlug}', 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/{automationSlug}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/automations/{automationSlug}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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": "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

automationSlug · string · required

Automation slug

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