Task

Subscribe to task workflow events

Subscribe to real-time task workflow events. The stream currently includes operation begin, operation end, and error events emitted by the task's conversation engine while a task execution is running. The response uses the same streaming envelope shape as conversation completion endpoints: each line is an event with a type, createdAt, and data.

post/task/{taskId}/subscribe

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/task/{taskId}/subscribe
  • Auth: HTTP bearer

Path parameters

taskIdstring required

The ID of the task

Request body

historyLengthinteger

Number of recent workflow events to replay before live events.

Response

Successfully subscribed to task workflow events

Changes

No recorded changes to this operation across all 1 revision of this API.