Skip to main content
POST
/
v2
/
workspaces
/
{workspaceId}
/
events
Send Workspace Event
curl --request POST \
  --url https://api.studio.prisme.ai/v2/workspaces/{workspaceId}/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    {
      "type": "apps.someApp.someCustomEvent",
      "payload": {
        "foo": "bar"
      }
    }
  ]
}
'
[
  {
    "id": "evt_abc123",
    "type": "runtime.executed.automation",
    "createdAt": "2024-01-15T10:30:00Z",
    "size": 256,
    "source": {
      "workspaceId": "ws_456",
      "automationSlug": "send-welcome-email"
    },
    "payload": {
      "slug": "send-welcome-email",
      "output": "{{result}}"
    }
  }
]

Authorizations

​
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

Body

application/json
​
events
object[]
required
Example:
[
  {
    "type": "apps.someApp.someCustomEvent",
    "payload": { "foo": "bar" }
  }
]

Response

Success Response

​
type
string
required
Example:

"apps.someApp.someCustomEvent"

​
source
object
required
​
createdAt
string
required

Creation date (ISO8601)

​
id
string
required
​
size
number
required
​
payload
any
​
target
object
​
options
object
​
error
object
Example:
[
  {
    "id": "evt_abc123",
    "type": "runtime.executed.automation",
    "createdAt": "2024-01-15T10:30:00Z",
    "size": 256,
    "source": {
      "workspaceId": "ws_456",
      "automationSlug": "send-welcome-email"
    },
    "payload": {
      "slug": "send-welcome-email",
      "output": "{{result}}"
    }
  }
]