From e4088ffdc0ae602b842ef8a59743bcb802ffd83d Mon Sep 17 00:00:00 2001
From: karishmas6 <carishmashukla28@gmail.com>
Date: Tue, 29 Oct 2024 00:09:08 +0530
Subject: [PATCH] chore: note about webhook feature

---
 server/src/api/record.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/server/src/api/record.ts b/server/src/api/record.ts
index 39052a68..46b4fe31 100644
--- a/server/src/api/record.ts
+++ b/server/src/api/record.ts
@@ -664,7 +664,7 @@ async function waitForRunCompletion(runId: string, interval: number = 2000) {
  * /api/robots/{id}/runs:
  *   post:
  *     summary: Run a robot by ID
- *     description: Start a new run for a specific robot.
+ *     description: When you need to run a robot and get its captured data, you can use this endpoint to run the task. For now, you can poll the GET endpoint to retrieve a task's details as soon as it is finished. We are working on adding a webhook feature to notify you when a task is finished.
  *     security:
  *       - api_key: []
  *     parameters: