feat(*): Introduce WebhookEventPayload<TWebhookEventType> for extract…

…ing typed webhook payloads
clerk · Feb 26, 2025 · cb6533b · cb6533b
1 parent 54a3b5b
commit cb6533b
Show file tree

Hide file tree

Showing 9 changed files with 40 additions and 0 deletions.
diff --git a/.changeset/thirty-tomatoes-brush.md b/.changeset/thirty-tomatoes-brush.md
@@ -0,0 +1,23 @@
+---
+'@clerk/tanstack-start': minor
+'@clerk/react-router': minor
+'@clerk/backend': minor
+'@clerk/nextjs': minor
+'@clerk/astro': minor
+'@clerk/remix': minor
+'@clerk/express': minor
+'@clerk/fastify': minor
+'@clerk/nuxt': minor
+---
+
+Introduces `WebhookEventPayload<TWebhookEventType>`, a utility type that allows to infer webhook payloads based on event types. 
+
+Usage: 
+```ts
+type UserCreatedPayload = WebhookEventPayload<"user.created">;
+//   ^? { 
+//          object: "event";
+//          data: UserJSON;
+//          type: "user.created";
+//      }
+```
diff --git a/packages/astro/src/server/index.ts b/packages/astro/src/server/index.ts
@@ -10,6 +10,7 @@ export type {
   OrganizationMembershipRole,
   // Webhook event types
   WebhookEvent,
+  WebhookEventPayload,
   WebhookEventType,
   // Resources
   AllowlistIdentifier,

diff --git a/packages/backend/src/api/resources/Webhooks.ts b/packages/backend/src/api/resources/Webhooks.ts
@@ -64,4 +64,14 @@ export type WebhookEvent =
   | RoleWebhookEvent
   | PermissionWebhookEvent;
 
+export type WebhookEventPayload<T extends WebhookEventType> = WebhookEvent extends infer U
+  ? U extends { type: infer K }
+    ? T extends K
+      ? Simplify<Omit<U, 'type'> & { type: T }>
+      : never
+    : never
+  : never;
+
 export type WebhookEventType = WebhookEvent['type'];
+
+type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {};
diff --git a/packages/backend/src/api/resources/index.ts b/packages/backend/src/api/resources/index.ts
@@ -47,6 +47,7 @@ export type {
   SMSWebhookEvent,
   UserWebhookEvent,
   WebhookEvent,
+  WebhookEventPayload,
   WebhookEventType,
 } from './Webhooks';
 

diff --git a/packages/backend/src/index.ts b/packages/backend/src/index.ts
@@ -127,6 +127,7 @@ export type {
   SMSWebhookEvent,
   UserWebhookEvent,
   WebhookEvent,
+  WebhookEventPayload,
   WebhookEventType,
 } from './api/resources/Webhooks';
 

diff --git a/packages/nextjs/src/server/index.ts b/packages/nextjs/src/server/index.ts
@@ -21,6 +21,7 @@ export type {
   SMSMessageJSON,
   UserJSON,
   WebhookEvent,
+  WebhookEventPayload,
   WebhookEventType,
   UserWebhookEvent,
   EmailWebhookEvent,

diff --git a/packages/react-router/src/ssr/index.ts b/packages/react-router/src/ssr/index.ts
@@ -8,6 +8,7 @@ export type {
   OrganizationMembershipRole,
   // Webhook event types
   WebhookEvent,
+  WebhookEventPayload,
   WebhookEventType,
   // Resources
   AllowlistIdentifier,

diff --git a/packages/remix/src/ssr/index.ts b/packages/remix/src/ssr/index.ts
@@ -8,6 +8,7 @@ export type {
   OrganizationMembershipRole,
   // Webhook event types
   WebhookEvent,
+  WebhookEventPayload,
   WebhookEventType,
   // Resources
   AllowlistIdentifier,

diff --git a/packages/tanstack-start/src/server/index.ts b/packages/tanstack-start/src/server/index.ts
@@ -10,6 +10,7 @@ export type {
   OrganizationMembershipRole,
   // Webhook event types
   WebhookEvent,
+  WebhookEventPayload,
   WebhookEventType,
   // Resources
   AllowlistIdentifier,