GET
/
v2
/
workspaces
/
{workspaceId}
/
events
curl --request GET \
  --url https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/events \
  --header 'X-Prismeai-API-Key: <api-key>'
{
  "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>"
        },
        "payload": "<any>",
        "target": {
          "userTopic": "<string>",
          "userId": "<string>",
          "sessionId": "<string>",
          "currentSocket": true
        },
        "options": {
          "persist": true,
          "aggPayload": true
        },
        "error": {
          "error": "<string>",
          "message": "<string>",
          "details": "<any>",
          "level": "warning"
        },
        "createdAt": "<string>",
        "id": "<string>",
        "size": 123
      }
    ]
  }
}

Authorizations

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

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

Was this page helpful?

Raise issue