Get v2workspaces events

Retrieve events filtered with any JSON path specified in GET parameters. Can be called as websocket.

GET /v2/workspaces/{workspaceId}/events

cURL

cURL

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

import requests

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

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}/events', 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}/events",
  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}/events"

	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}/events")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "result": {
    "events": [
      {
        "type": "apps.someApp.someCustomEvent",
        "source": {
          "appSlug": "<string>",
          "appInstanceFullSlug": "<string>",
          "appInstanceDepth": 123,
          "automationSlug": "<string>",
          "automationDepth": 123,
          "userId": "<string>",
          "ip": "<string>",
          "sessionId": "<string>",
          "workspaceId": "<string>",
          "socketId": "<string>",
          "host": {
            "service": "<string>"
          },
          "correlationId": "<string>",
          "serviceTopic": "<string>"
        },
        "createdAt": "<string>",
        "id": "<string>",
        "size": 123,
        "payload": "<unknown>",
        "target": {
          "userTopic": "<string>",
          "userId": "<string>",
          "sessionId": "<string>",
          "currentSocket": true
        },
        "options": {
          "persist": true,
          "aggPayload": false,
          "async": false
        },
        "error": {
          "error": "<string>",
          "message": "<string>",
          "details": "<unknown>",
          "level": "warning"
        }
      }
    ]
  }
}

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

ID of workspace to listen to

Query Parameters

text · string

Search these keywords

beforeId · string

Match every events created before given eventId

appInstanceDepth · number

Match only events from appInstances not exceeding that depth

query · object

types · string

Comma separated list of listened event types

afterDate · string

Retrieve events created after this ISO8601 formatted date

beforeDate · string

Retrieve events created before this ISO8601 formatted date

page · number

Page number

limit · number

Page size

sort · enum<string>

Sort order, asc for oldest first & 'desc' for earliest first. Earliest first by default

Available options: asc, desc

Response

200

application/json

Success Response

result · object

Show child attributes