-
Notifications
You must be signed in to change notification settings - Fork 6
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
Add events and API changes for invitations and Magic Auth #221
Conversation
Should this PR be based off of the |
Ah that's my bad - I meant to do that and messed up when creating the PR |
Ok I selected the correct branch now |
* @param createdAt The timestamp when the invitation was created. | ||
* @param updatedAt The timestamp when the invitation was last updated. | ||
*/ | ||
data class InvitationEvent @JsonCreator constructor( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Confirming my understanding - fetching invitations from the API contains the acceptInvitationUrl
key, but the Invitation object returned for events does not, is that correct?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The API response object contains the token
and the acceptInvitationUrl
but the event does not, as those are secrets, which we don't want to expose in events. More context in the decision log here: https://workos.quip.com/lLKGA1TcBTrV/User-Management-Configurable-Emails-Decision-Log#temp:C:GRO1a7c777038db4dea886af97c8
18a5bb5
to
9a844a4
Compare
Description
Adds events and API changes to support sending your own emails for invitations and Magic Auth.
acceptInvitationUrl
to invitation object returned by APIgetMagicAuth
andcreateMagicAuth
sendMagicAuthCode
method in favor ofcreateMagicAuth
invitation.created
andmagic_auth.created
Documentation
Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.
If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.
https://github.com/workos/workos/pull/26691