Improve documentation for inbound and outbound webhooks #352
+42
−27
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.
This pull request includes several changes to the documentation and configuration files to improve clarity and consistency regarding webhooks and payment handling. The most important changes include renaming webhook routes, updating documentation for inbound and outbound webhooks, and restructuring the documentation navigation.
Webhook Route Updates:
apps/api/package.json
: Updated the Stripe webhook route to/webhooks/payments
to reflect the new naming convention.Documentation Updates:
docs/features/analytics/product.mdx
: Updated thegraph TD
to reflect the new webhook routes for Clerk and Stripe.docs/features/authentication.mdx
: Revised the section on Clerk webhooks to link to the new inbound authentication webhooks documentation.docs/features/payments.mdx
: Updated the description and webhook handling section to reflect the new payment webhooks route and added a link to the inbound payment webhooks documentation. [1] [2]docs/features/webhooks/inbound.mdx
: Added new documentation for inbound webhooks, including payment and authentication events, and local development tips.docs/features/webhooks/outbound.mdx
: Renamed fromdocs/features/webhooks.mdx
and updated to focus on outbound webhooks using Svix.Documentation Navigation:
docs/mint.json
: Restructured the documentation navigation to group inbound and outbound webhooks under a single "Webhooks" group. [1] [2]