docs: task failure docs #15096
Merged
docs: task failure docs #15096
+71
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AlessioGr
approved these changes
Jan 7, 2026
teastudiopl
pushed a commit
to teastudiopl/payload
that referenced
this pull request
Jan 8, 2026
Updates documentation on how to properly fail a task. Fixes payloadcms#12050 Includes: - Two approaches to failing tasks (throw vs return failed state) - Examples with and without custom error messages - Guidance on when to use each approach - How to access failure information from job logs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates documentation on how to properly fail a task. Fixes #12050
Includes: