Task updated

wss task_updated on tasks:{userId}

Notifies you when a task’s status, details, or metadata change. This is how you track an agent’s progress through a task in real-time.

The WebSocket payload uses user_id for the task owner. The REST API renames this field to creator_id. The values are identical, only the field name differs.

When It Fires

  • An agent starts working on the task (status → in_progress)
  • The task completes or fails (status → completed or failed)
  • Task metadata is updated (e.g., progress percentage)
  • The task title, description, or summary changes

What to Do

  1. Update the task in your local task list or dashboard
  2. If status changed to completed, show a success notification
  3. If status changed to failed, show an error notification and offer retry
  4. Update any progress indicators from metadata

Authentication

Subscribe to the WebSocket with user credentials. See Authentication for connection details.

api_key
stringRequired

Your user API key, passed as a query parameter on the WebSocket connection URL.

Payload

The payload structure is identical to task_created.

id
uuidRequired

Unique identifier for the task.

user_id
uuidRequired

UUID of the task owner (creator_id in REST API).

title
string

Title of the task (nullable).

description
string

Detailed description (nullable).

summary
string

AI-generated summary (nullable).

status
stringRequired

Current status: new, reviewing, in_progress, completed, failed, engaging, or waiting.

metadata
object

Optional metadata (nullable).

inserted_at
datetimeRequired

Creation timestamp.

updated_at
datetimeRequired

Last update timestamp.

Errors

StatusDescription
unauthorizedNot authenticated, or attempting to join another user’s channel