Skip to content

Automate browser based workflows with AI

update webhook_url docstring (#2587)

Shuchang Zheng8acefa1fe2a5
diff --git a/fern/running-tasks/webhooks-faq.mdx b/fern/running-tasks/webhooks-faq.mdx
index a38cc173b..e4eaeabc2 100644
--- a/fern/running-tasks/webhooks-faq.mdx
+++ b/fern/running-tasks/webhooks-faq.mdx
@@ -8,8 +8,8 @@ slug: running-tasks/webhooks-faq
Task runtimes can exceed default HTTP timeouts; we recommend using webhook notifications to inform you when the run is complete.
To set up webhook callback:
-- Set [webhook_url in Run Task](api-reference/api-reference/agent/run-task#request.body.webhook_url) to receive the update when the task is done.
-- Set [webhook_url in Run Workflow](https://docs.skyvern.com/api-reference/api-reference/agent/run-workflow#request.body.webhook_url) to receive the update when a workflow run is done.
+- Set [webhook_url in Run Task](/api-reference/api-reference/agent/run-task#request.body.webhook_url) to receive the update when the task is done.
+- Set [webhook_url in Run Workflow](/api-reference/api-reference/workflows/run-workflow#request.body.webhook_url) to receive the update when a workflow run is done.
To fetch the status of a run:
- Use the [Get Run](/api-reference/api-reference/agent/get-run) endpoint for the status of a task or workflow run
diff --git a/skyvern/client/types/task_run_request.py b/skyvern/client/types/task_run_request.py
index aeebcc449..d0c97878f 100644
--- a/skyvern/client/types/task_run_request.py
+++ b/skyvern/client/types/task_run_request.py
@@ -80,7 +80,7 @@ class TaskRunRequest(UniversalBaseModel):
webhook_url: typing.Optional[str] = pydantic.Field(default=None)
"""
- URL to send task status updates to after a run is finished. Refer to https://docs.skyvern.com/running-tasks/webhooks-faq for more details.
+ After a run is finished, send an update to this URL. Refer to https://docs.skyvern.com/running-tasks/webhooks-faq for more details.
"""
totp_identifier: typing.Optional[str] = pydantic.Field(default=None)
diff --git a/skyvern/schemas/docs/doc_strings.py b/skyvern/schemas/docs/doc_strings.py
index 9a7406539..3bab0bf07 100644
--- a/skyvern/schemas/docs/doc_strings.py
+++ b/skyvern/schemas/docs/doc_strings.py
@@ -47,7 +47,7 @@ Maximum number of steps the task can take. Task will fail if it exceeds this num
"""
WEBHOOK_URL_DOC_STRING = """
-URL to send task status updates to after a run is finished. Refer to https://docs.skyvern.com/running-tasks/webhooks-faq for more details.
+After a run is finished, send an update to this URL. Refer to https://docs.skyvern.com/running-tasks/webhooks-faq for more details.
"""
TOTP_IDENTIFIER_DOC_STRING = """