mirror of https://github.com/stack-auth/stack.git synced 2026-06-13 21:01:21 +08:00

History

BilalG1 2e892664f3 webhook testing (#964 ) https://www.loom.com/share/abbd19d1deaa4b3d8f8ae9c1f2f9b098?sid=d105ee21-f380-4c37-85f1-a58610cfff9d <!-- Make sure you've read the CONTRIBUTING.md guidelines: https://github.com/stack-auth/stack-auth/blob/dev/CONTRIBUTING.md --> <!-- RECURSEML_SUMMARY:START --> ## High-level PR Summary This PR adds webhook testing functionality to the dashboard, allowing users to send test events to their configured webhook endpoints and verify they're working correctly. The implementation adds a new backend API endpoint that creates a `stack.test` event via Svix, verifies successful delivery, and provides clear feedback. The dashboard UI is enhanced with a test dialog that shows a preview of the test payload and displays success or error messages, with the test action accessible both from the endpoint creation flow and the action menu for existing endpoints. ⏱️ Estimated Review Time: 15-30 minutes <details> <summary>💡 Review Order Suggestion</summary> \| Order \| File Path \| \|-------\|-----------\| \| 1 \| `packages/stack-shared/src/interface/admin-interface.ts` \| \| 2 \| `packages/template/src/lib/stack-app/apps/interfaces/admin-app.ts` \| \| 3 \| `packages/template/src/lib/stack-app/apps/implementations/admin-app-impl.ts` \| \| 4 \| `apps/backend/src/app/api/latest/internal/send-test-webhook/route.tsx` \| \| 5 \| `apps/dashboard/src/app/(main)/(protected)/projects/[projectId]/webhooks/page-client.tsx` \| </details> [![Need help? Join our Discord](https://img.shields.io/badge/Need%20help%3F%20Join%20our%20Discord-5865F2?style=plastic&logo=discord&logoColor=white)](https://discord.gg/n3SsVDAW6U) [![Analyze latest changes](`a9ad94e61f`/?repo_owner=stack-auth&repo_name=stack-auth&pr_number=964) <!-- RECURSEML_SUMMARY:END --> <!-- ELLIPSIS_HIDDEN --> ---- > [!IMPORTANT] > Add functionality to test webhooks from the dashboard, including backend route and frontend UI updates. > > - Backend: > - Adds `POST` route in `send-test-webhook/route.tsx` to handle test webhook requests. > - Validates request and response schemas using `yup`. > - Implements logic to send test webhook using `svix` and handle success/error cases. > - Frontend: > - Updates `page-client.tsx` to include a dialog for creating and testing endpoints. > - Adds `TestEndpointDialog` component to handle the test webhook UI. > - Modifies `CreateDialog` and `ActionMenu` to support triggering the test webhook. > - Admin Interface: > - Adds `sendTestWebhook` method to `StackAdminInterface` in `admin-interface.ts`. > - Implements `sendTestWebhook` in `_StackAdminAppImplIncomplete` in `admin-app-impl.ts`. > - Updates `StackAdminApp` interface in `admin-app.ts` to include `sendTestWebhook` method. > > <sup>This description was created by </sup>[<img alt="Ellipsis" src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=stack-auth%2Fstack-auth&utm_source=github&utm_medium=referral)<sup> for `c9bc00cb50`. You can [customize](https://app.ellipsis.dev/stack-auth/settings/summaries) this summary. It will automatically update as commits are pushed.</sup> <!-- ELLIPSIS_HIDDEN --> Co-authored-by: Konsti Wohlwend <n2d4xc@gmail.com>		2025-11-05 17:09:53 -08:00
..
scripts	Widget playground mobile mode	2025-07-14 20:04:43 -07:00
src	webhook testing (#964 )	2025-11-05 17:09:53 -08:00
.env	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
.eslintrc.cjs	tsup for stack-shared (#647 )	2025-04-28 21:26:52 -07:00
.gitignore	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
CHANGELOG.md	chore: update package versions	2025-10-29 18:13:53 -07:00
components.json	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
LICENSE	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
next-env.d.ts	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
package-template.json	chore: update package versions	2025-10-29 18:13:53 -07:00
package.json	chore: update package versions	2025-10-29 18:13:53 -07:00
postcss.config.js	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
quetzal.config.json	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
README.md	Update branding from Stack to Stack Auth in documentation (#504 )	2025-03-04 04:07:54 +01:00
tailwind.config.js	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
tsconfig.json	In-source unit tests (#429 )	2025-02-14 11:47:52 -08:00
tsup.config.ts	Convex README	2025-10-10 04:27:05 -07:00
vitest.config.ts	In-source unit tests (#429 )	2025-02-14 11:47:52 -08:00

README.md

Stack Auth: Open-source Clerk/Auth0 alternative

📘 Docs | ☁️ Hosted Version | ✨ Demo | 🎮 Discord | GitHub

Stack Auth is a managed user authentication solution. It is developer-friendly and fully open-source (licensed under MIT and AGPL).

Stack Auth gets you started in just five minutes, after which you'll be ready to use all of its features as you grow your project. Our managed service is completely optional and you can export your user data and self-host, for free, at any time.

We support Next.js frontends, along with any backend that can use our REST API. Check out our setup guide to get started.

📦 Installation & Setup

Run Stack Auth's installation wizard with the following command:
```
npx @stackframe/init-stack@latest
```
Then, create an account on the Stack Auth dashboard, create a new project with an API key, and copy its environment variables into the .env.local file of your Next.js project:
```
NEXT_PUBLIC_STACK_PROJECT_ID=<your-project-id>
NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY=<your-publishable-client-key>
STACK_SECRET_SERVER_KEY=<your-secret-server-key>
```
That's it! You can run your app with npm run dev and go to http://localhost:3000/handler/signup to see the sign-up page. You can also check out the account settings page at http://localhost:3000/handler/account-settings.

Check out the documentation for a more detailed guide.