Skip to content
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.

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

feat(backend): organization_domain webhook event types #4819

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ijxy
Copy link
Contributor

@ijxy ijxy commented Dec 20, 2024

Adds the types for Organization Domain webhook events

Description

Fixes #4818

To align with the rest of the JSON resources in @clerk/backend, I have copied the OrganizationDomainJSON and OrganizationDomainVerificationJSON types from @clerk/types.

Worth mentioning that the JSON type has affiliation_email_address and verification as nullable, whereas the webhook docs don't. I have assumed that the code is correct and kept the nullable fields.

image

Note: The relationship between @clerk/backend and @clerk/types seems a bit strange in that all(?) the JSON resources appear to be defined identically in both independently. I assume that there is a reason for this so I have not refactored it.

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other: adds missing types

Copy link

changeset-bot bot commented Dec 20, 2024

🦋 Changeset detected

Latest commit: 52cc866

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 11 packages
Name Type
@clerk/tanstack-start Patch
@clerk/react-router Patch
@clerk/backend Patch
@clerk/nextjs Patch
@clerk/astro Patch
@clerk/remix Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/nuxt Patch
@clerk/clerk-sdk-node Patch
@clerk/testing Patch

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

Copy link

vercel bot commented Dec 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
clerk-js-sandbox ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 9, 2025 8:52pm

Adds the types for Organization Domain webhook events
Copy link
Contributor

@NicolasLopes7 NicolasLopes7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution @ijxy! The changes looks good to me

@ijxy
Copy link
Contributor Author

ijxy commented Jan 10, 2025

Thanks for your contribution @ijxy! The changes looks good to me

Awesome! What's the deal with all the failing CI integration tests? Is that an upstream issue or a problem related to this patch?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing types for Organization Domain webhook events
4 participants