chore(backend): Added types to webhook json for waitlist entry #5148
Conversation
🦋 Changeset detectedLatest commit: d66f110 The changes in this PR will be included in the next version bump. This PR includes changesets to release 11 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| export interface WaitlistEntryJSON extends ClerkResourceJSON { | ||
| created_at: number; | ||
| email_address: string; | ||
| id: string; | ||
| invitation: InvitationJSON | null; | ||
| object: typeof ObjectType.WaitlistEntry; | ||
| status: string; | ||
| updated_at: number; | ||
| } |
There was a problem hiding this comment.
Hey @mackenzienolan,
Thank you for the contribution 🤝
We should add also the is_locked: boolean property because we return the same resource as we have in the Backend API ref
There was a problem hiding this comment.
Nice catch! Added is_locked. Was checking the webhook catalog and didn't double check the api.
panteliselef
changed the title
| '@clerk/backend': patch | ||
| --- | ||
|
|
||
| Added WaitlistEntryJSON and updated WebhookEvent to include WaitlistEntry |
There was a problem hiding this comment.
| Added WaitlistEntryJSON and updated WebhookEvent to include WaitlistEntry | |
| Add waitlist entry types | |
| - `WaitlistEntryJSON` | |
| - `WaitlistEntryWebhookEvent` | |
| Update `WebhookEvent` to include `WaitlistEntryWebhookEvent` |
| @@ -52,6 +53,8 @@ export type PermissionWebhookEvent = Webhook< | |||
| PermissionJSON | |||
| >; | |||
|
|
|||
| export type WaitlistEntryWebhookEvent = Webhook<'waitlistEntry.created' | 'waitlistEntry.updated', WaitlistEntryJSON>; | |||
There was a problem hiding this comment.
Hey @mackenzienolan,
can you include the WaitlistEntryWebhookEvent in the webhooks export we have in packages/backend/src/api/resources/index.ts? :)
export type {
EmailWebhookEvent,
OrganizationWebhookEvent,
OrganizationDomainWebhookEvent,
OrganizationInvitationWebhookEvent,
OrganizationMembershipWebhookEvent,
PermissionWebhookEvent,
RoleWebhookEvent,
SessionWebhookEvent,
SMSWebhookEvent,
UserWebhookEvent,
WebhookEvent,
WebhookEventType,
WaitlistEntryWebhookEvent,
} from './Webhooks';
Description
Added JSON types for WaitlistEntry for use with WebhookEvent
#5143
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change