(/integrations/webhooks/sync-data) update guide #1655
Merged
Conversation
This file contains 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
victoriaxyz
changed the title
victoriaxyz
changed the title
|
Hey, here’s your docs preview: https://clerk.com/docs/pr/1655 |
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
royanger
reviewed
Nov 1, 2024
Co-authored-by: Roy Anger <[email protected]>
royanger
requested changes
Nov 1, 2024
| - `user.updated`: Triggers when user information is updated via Clerk components, the Clerk Dashboard, or Backend API. Listening to this event keeps data synced between Clerk and your external database. It is recommended to only sync what you need to simplify this process. | ||
| - `user.deleted`: Triggers when a user deletes their account, or their account is removed via the Clerk Dashboard or Backend API. Listening to this event allows you to delete the user from your database or add a `deleted: true` flag. | ||
|
|
||
| These steps apply to any Clerk event. To make the setup process easier, it's recommended to keep two browser tabs open: one for your Clerk [**Webhooks**](https://dashboard.clerk.com/last-active?path=webhooks) page and one for your [ngrok dashboard](https://dashboard.ngrok.com). | ||
|
|
||
| <Steps> | ||
| ### Set up ngrok | ||
|
|
There was a problem hiding this comment.
minor nit: After the 'Set up ngrok' section, the guide never refers to the ngrok dashboard. We could probably skip suggesting the customer keep this open.
There was a problem hiding this comment.
Leaving this note in case the customer needs to access their secrets again.
Co-authored-by: Roy Anger <[email protected]>
Co-authored-by: Roy Anger <[email protected]>
alexisintech
reviewed
Nov 5, 2024
Comment on lines
77
to
81
| Incoming webhook events have no auth information. They come from an external source and will not be signed in or signed out. To allow access, the route must be public. | ||
|
|
||
| The following example shows the recommended Middleware configuration for webhook routes. | ||
|
|
||
| ```ts {{ filename: 'middleware.ts' }} | ||
| import { clerkMiddleware } from '@clerk/nextjs/server' | ||
|
|
||
| // Make sure that the `/api/webhooks(.*)` route is not protected here | ||
| export default clerkMiddleware() | ||
| Incoming webhook events contain no authentication information. They come from an external source and won't be signed in or signed out, so the route must be public to allow access. | ||
|
|
||
| export const config = { | ||
| matcher: [ | ||
| // Skip Next.js internals and all static files, unless found in search params | ||
| '/((?!_next|[^?]*\\.(?:html?|css|js(?!on)|jpe?g|webp|png|gif|svg|ttf|woff2?|ico|csv|docx?|xlsx?|zip|webmanifest)).*)', | ||
| // Always run for API routes | ||
| '/(api|trpc)(.*)', | ||
| ], | ||
| } | ||
| ``` | ||
| To configure your Middleware, refer to the [clerkMiddleware() guide](docs/references/nextjs/clerk-middleware). |
There was a problem hiding this comment.
looks like you repeat information here.
also the sentence ends wtih "so the route must be public to allow access". and then the next sentence goes into configuring your middleware.
there should be some relational information that ties these two concepts together:
"so the route must be public to allow access. If you are using clerkMiddleware(), you will need to ensure that the /api/webhooks(.*) route is public. For more information on configuring routes with clerkMiddleware(), see the reference.
also don't forget that clerkMiddleware() always needs to be in code snippets. even if it's in a link
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
royanger
approved these changes
Nov 12, 2024
Co-authored-by: Roy Anger <[email protected]>
Co-authored-by: Roy Anger <[email protected]>
alexisintech
approved these changes
Nov 15, 2024
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.
Important
🔎 Previews:
Explanation:
This PR: