Skip to content

docs: note that onCancel only runs during active execution #3119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matt-aitken merged 2 commits into from
Feb 23, 2026
Merged

docs: note that onCancel only runs during active execution #3119

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6bf2880
added onCancel note
isshaddad Feb 23, 2026
912ade7
Merge branch 'main' into docs/on-cancel-limitation
isshaddad Feb 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/tasks/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -535,6 +535,13 @@ export const cancelExampleTask = task({
point the process will be killed.
</Note>

<Warning>
`onCancel` only runs if the run is actively executing. If a run is cancelled while queued or
suspended (e.g. waiting for a token), no machine is spun up and `onCancel` will not be called.
This is a known limitation we're planning to address. Follow the progress on our [feedback
board](https://feedback.trigger.dev/p/call-the-onfailure-hook-for-runs-that-were-canceled-expired).
</Warning>

### `onStart` function (deprecated)

<Info>The `onStart` function was deprecated in v4.1.0. Use `onStartAttempt` instead.</Info>
Expand Down