API Reference

For the REST API docs go here

Real-time Messaging (WebSocket)

The application uses a WebSocket gateway to handle real-time user sessions and stream task execution updates.

These events are emitted by the client to manage the session.

Event Name Description Payload

Event Name	Description	Payload
`joinRoom`	Joins the user to their private notification channel based on their JWT user ID.	None (User ID extracted from token)
`leaveRoom`	Removes the user from their private notification channel.	None (User ID extracted from token)

joinRoom

Joins the user to their private notification channel based on their JWT user ID.

None (User ID extracted from token)

leaveRoom

Removes the user from their private notification channel.

None (User ID extracted from token)

These events are pushed from the server to connected clients.

Event Name Description Payload

Event Name	Description	Payload
`execution-response`	Emitted when a task execution status changes (updates, completion, or failure).	Object (See JSON example below)

execution-response

Emitted when a task execution status changes (updates, completion, or failure).

Object (See JSON example below)

Event: execution-response

{
  "projectId": 1,
  "name": "example",
  "taskId": 2,
  "status": "failed",
  "error": "error message"
}