send webhook when task or workflow run is canceled

[wintonzheng]

Important

Send webhooks when tasks or workflow runs are canceled by updating execute_step(), execute_workflow(), and related functions to handle webhook execution.

• Behavior:
  • Send webhook when task or workflow run is canceled by setting need_call_webhook=True in execute_step() in agent.py and execute_workflow() in service.py.
  • Modify cancel_task() and cancel_workflow_run() in agent_protocol.py to include x_api_key for webhook execution.
• Functions:
  • Update execute_task_webhook() in agent.py to accept last_step as Step | None.
  • Add execute_workflow_webhook() in service.py to handle webhook execution for workflow runs.
• Misc:
  • Minor logging adjustments in service.py for webhook execution.

^{This description was created by for ac4a400. It will automatically update as commits are pushed.}

[ellipsis-dev]

👍 Looks good to me! Reviewed everything up to ac4a400 in 25 minutes and 27 seconds

More details

• Looked at 154 lines of code in 3 files
• Skipped 0 files when reviewing.
• Skipped posting 4 drafted comments based on config settings.

1. skyvern/forge/agent.py:1546

• Draft comment:
  The change to accept last_step as Step | None in execute_task_webhook is appropriate and consistent with its usage.
• Reason this comment was not posted:
  Confidence changes required: 0%
  The change in execute_task_webhook method to accept last_step as Step | None is appropriate, as it allows for flexibility when the last step might not be available. This change is consistent with the usage in the codebase.

2. skyvern/forge/sdk/workflow/service.py:888

• Draft comment:
  The change to accept api_key as str | None in execute_workflow_webhook is appropriate and consistent with its usage.
• Reason this comment was not posted:
  Confidence changes required: 0%
  The change in execute_workflow_webhook method to accept api_key as str | None is appropriate, as it allows for cases where the API key might not be provided. This change is consistent with the usage in the codebase.

3. skyvern/forge/sdk/routes/agent_protocol.py:287

• Draft comment:
  The addition of x_api_key as a header in cancel_task is appropriate for passing API keys for authentication.
• Reason this comment was not posted:
  Confidence changes required: 0%
  The change in cancel_task to include x_api_key as a header is consistent with the need to pass API keys for authentication and is used correctly in the function.

4. skyvern/forge/sdk/routes/agent_protocol.py:308

• Draft comment:
  The addition of x_api_key as a header in cancel_workflow_run is appropriate for passing API keys for authentication.
• Reason this comment was not posted:
  Confidence changes required: 0%
  The change in cancel_workflow_run to include x_api_key as a header is consistent with the need to pass API keys for authentication and is used correctly in the function.

Workflow ID: wflow_mRaU7xEO2B9PxSqw

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

[LawyZheng]

shall we just only send the webhook when task/workflow cancellation is finished? any specific reason why we must send the webhook in the API call?

[LawyZheng]

if user call multiple times to the cancle endpoint. he will receive multiple times the webhook without any task/workflow being cancelled 🤔

[wintonzheng]

users can also cancel tasks that are stuck. our worker won't really send a webhook if we don't send a webhook to them in the API endpoint.

[wintonzheng]

i think it's okay that we send two cancel task webhook.

[LawyZheng]

same question as task