Repository navigation
docs(portal-extension): document dataExport and account management hooks - #164
Merged
Merged
Conversation
Add the dataExport, changeEmail, changePassword and deleteAccount hook types, which exist in the app-api spec but were missing from the docs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RP5hkrawFeehBJxe6yCJX3
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
1 participant
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.
Summary
The portal extension hooks page was missing 4 of the 11 hook types defined in the app-api spec (
PortalExtensionHookinapp-api/openapi.yml). This PR adds them:dataExport): hands block exports (CSV/Excel/PDF) to the app's own API. Coversblock_types, the response format (download_urlrequired, plusfilename,content_typeandexpires_at), error handling and template variables.changeEmail:change_mode(synchronous/asynchronous),require_password_confirmation, the default body and theInput.new_email/Input.old_emailvariableschangePassword:require_new_passwordandInput.new_passworddeleteAccount:deletion_modeanddelete_contact(none/soft/hard)The default request bodies and template variables were checked against the hook execution code in
customer-portal-api(extension/hook-execution.tsanduser/user-handlers.ts).Test plan
/docs/apps/components/portal-extension#hooks🤖 Generated with Claude Code
https://claude.ai/code/session_01RP5hkrawFeehBJxe6yCJX3
Generated by Claude Code