docs: add info about custom errors via APIError to hooks overview
#13047
+20
−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
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.
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.