Skip to content

fix(docs): add note to highlight default dummy clerk webhook signing secret #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nednella merged 1 commit into from
Nov 20, 2025
Merged

fix(docs): add note to highlight default dummy clerk webhook signing secret #166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions apps/api/.env.dev.template
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# ==============================
# LOCAL DEVELOPMENT ENV TEMPLATE
# ==============================

# Database
DB_HOST=localhost
DB_PORT=5432
DB_NAME=echo
DB_USERNAME=admin
DB_PASSWORD=pw123

# Authentication
CLERK_ISSUER_URI=
CLERK_JWK_SET_URI=

# Clerk
CLERK_SECRET_KEY=
CLERK_WEBHOOK_SIGNING_SECRET=whsec_DUMMYKEY

# CORS (comma-separated values)
CORS_ALLOWED_ORIGINS=http://localhost:5173
# ==============================
# LOCAL DEVELOPMENT ENV TEMPLATE
# ==============================
# Database
DB_HOST=localhost
DB_PORT=5432
DB_NAME=echo
DB_USERNAME=admin
DB_PASSWORD=pw123
# Authentication
CLERK_ISSUER_URI=
CLERK_JWK_SET_URI=
# Clerk
CLERK_SECRET_KEY=
CLERK_WEBHOOK_SIGNING_SECRET=whsec_DUMMYKEY # placeholder dummy key to prevent runtime exceptions on boot
# CORS (comma-separated values)
CORS_ALLOWED_ORIGINS=http://localhost:5173
5 changes: 4 additions & 1 deletion docs/clerk-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,9 @@ For the Spring Boot REST API, you will need:

## OPTIONAL: Webhooks

> [!IMPORTANT]
> By default, the `.env.dev.template` file contains a dummy webhook signing secret that will prevent exceptions from being thrown upon boot.

> [!IMPORTANT]
> You will require a tunnelling service to expose your localhost port to the web. [Ngrok is the recommended option by Clerk](https://clerk.com/docs/webhooks/sync-data), but you may use any tunnelling service of your choice.

Expand All @@ -108,7 +111,7 @@ For the Spring Boot REST API, you will need:
<br />

```
{YOUR_TUNNEL_URL}/api/v1/clerk/webhook
{YOUR_TUNNEL_URL}/v1/clerk/webhook
```

<img src="./assets/clerk_webhook_configuration.png" width="600">
Expand Down
Loading