docs: add info about custom errors via APIError to hooks overview#13047
Merged
Conversation
Contributor
|
This seems like a good addition to the docs. I was trying to do precisely what @codeflorist mentioned and found a discussion in discord. It would be helpful to have this information in the docs IMO. |
paulpopus
approved these changes
Apr 2, 2026
Contributor
|
🚀 This is included in version v3.82.0 |
milamer
pushed a commit
to milamer/payload
that referenced
this pull request
Apr 20, 2026
…ayloadcms#13047) <!-- Thank you for the PR! Please go through the checklist below and make sure you've completed all the steps. Please review the [CONTRIBUTING.md](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md) document in this repository if you haven't already. The following items will ensure that your PR is handled as smoothly as possible: - PR Title must follow conventional commits format. For example, `feat: my new feature`, `fix(plugin-seo): my fix`. - Minimal description explained as if explained to someone not immediately familiar with the code. - Provide before/after screenshots or code diffs if applicable. - Link any related issues/discussions from GitHub or Discord. - Add review comments if necessary to explain to the reviewer the logic behind a change --> ### What? I was searching for info on how to return custom errors in hooks and only came upon this discord answer by Dan Ribbons: https://payloadcms.com/community-help/github/customize-rest-api-response-in-collection-hooks ### Why? I think this info should be in the docs. ### How? This PR adds a `Cusom Error Messages` section to the hooks-overview page, detailing the usage of `APIError` as proposed by Dan Ribbons in the above discord answer. Co-authored-by: Paul Popus <paul@payloadcms.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What?
I was searching for info on how to return custom errors in hooks and only came upon this discord answer by Dan Ribbons:
https://payloadcms.com/community-help/github/customize-rest-api-response-in-collection-hooks
Why?
I think this info should be in the docs.
How?
This PR adds a
Cusom Error Messagessection to the hooks-overview page, detailing the usage ofAPIErroras proposed by Dan Ribbons in the above discord answer.