vodorod/Dorod-Sky
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

update webhook_url docstring (#2587)

Browse Source
This commit is contained in:
Shuchang Zheng
2025-06-03 15:33:34 -07:00
committed by GitHub
parent b818255ca7
commit 8acefa1fe2
3 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
fern/running-tasks/webhooks-faq.mdx
View File

@@ -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. 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: 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 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 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: 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 - Use the [Get Run](/api-reference/api-reference/agent/get-run) endpoint for the status of a task or workflow run

2
skyvern/client/types/task_run_request.py
View File

@@ -80,7 +80,7 @@ class TaskRunRequest(UniversalBaseModel):
webhook_url: typing.Optional[str] = pydantic.Field(default=None) 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) totp_identifier: typing.Optional[str] = pydantic.Field(default=None)

2
skyvern/schemas/docs/doc_strings.py
View File

@@ -47,7 +47,7 @@ Maximum number of steps the task can take. Task will fail if it exceeds this num
""" """
WEBHOOK_URL_DOC_STRING = """ 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 = """ TOTP_IDENTIFIER_DOC_STRING = """