Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Type constructEvent payload parameter as Record<string, unknown> #1307

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.

Sign up for GitHub

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

Jump to bottom
Merged
mattgd merged 4 commits into from
Jul 11, 2025
Merged

Type constructEvent payload parameter as Record<string, unknown> #1307

mattgd merged 4 commits into from
Jul 11, 2025

Conversation

@mattgd
Copy link
Contributor

@mattgd mattgd commented Jul 11, 2025

Description

Type constructEvent payload parameter as Record<string, unknown>.

Example usage:

app.post("/webhooks", async (request, response) => {
  const payload = request.body;
  const sigHeader = request.headers["workos-signature"] as string;

  const webhook = await workosClient.webhooks.constructEvent({
    payload,
    sigHeader,
    secret: WEBHOOK_SECRET,
  });

  const data = webhook.data;

  // Verify the signature and process the event
  response.status(200).end();
});

Documentation

Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.

[ ] Yes

If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.

@mattgd mattgd requested a review from nicknisi July 11, 2025 13:39
@mattgd mattgd self-assigned this Jul 11, 2025
@mattgd mattgd requested a review from a team as a code owner July 11, 2025 13:39
@linear
Copy link

linear bot commented Jul 11, 2025

ENT-3465 Node SDK `workos.webhooks.constructEvent()` type should only accept a JSON object

greptile-apps[bot]
greptile-apps bot reviewed Jul 11, 2025
View reviewed changes
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

PR Summary

Modified the type signature of the constructEvent method's payload parameter in src/webhooks/webhooks.ts to improve type safety for webhook handling.

  • Changed payload type from unknown to Record<string, unknown> for better type safety and autocomplete support
  • Caution: Implementation uses unsafe type assertion (unknown as EventResponse) which could lead to runtime errors if payload structure doesn't match
  • Consider implementing runtime validation to ensure payload matches EventResponse type before assertion

1 file reviewed, 1 comment
Edit PR Review Bot Settings | Greptile

mattgd
mattgd commented Jul 11, 2025
View reviewed changes
src/workos.ts
Comment on lines 69 to 72
constructor(
readonly key?: string,
readonly options: WorkOSOptions = {},
) {
Copy link
Contributor Author

@mattgd mattgd Jul 11, 2025

Choose a reason for hiding this comment

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

Not sure why CI was giving me a formatter error for this.

@mattgd mattgd merged commit 39ab2f2 into version-8 Jul 11, 2025
7 checks passed
@mattgd mattgd deleted the feature/ent-3465-node-sdk-workoswebhooksconstructevent-type-should-only branch July 11, 2025 13:56
@stacurry stacurry mentioned this pull request Jul 16, 2025
Merged
stacurry added a commit that referenced this pull request Jul 16, 2025
@stacurry
bump version to 7.60.0 (#1309)
616ee45 
## Description
version bump that includes:
- #1307
- #1308

## Documentation

Does this require changes to the WorkOS Docs? E.g. the [API
Reference](https://workos.com/docs/reference) or code snippets need
updates.

```
[ ] Yes
```

If yes, link a related docs PR and add a docs maintainer as a reviewer.
Their approval is required.
nicknisi pushed a commit that referenced this pull request Jul 17, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
84385a1 
Type constructEvent payload parameter as Record<string, unknown>.
nicknisi pushed a commit that referenced this pull request Aug 5, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
87a232b 
Type constructEvent payload parameter as Record<string, unknown>.
nicknisi pushed a commit that referenced this pull request Aug 7, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
653a857 
Type constructEvent payload parameter as Record<string, unknown>.
nicknisi pushed a commit that referenced this pull request Aug 19, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
879caf1 
Type constructEvent payload parameter as Record<string, unknown>.
nicknisi pushed a commit that referenced this pull request Aug 25, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
7abb504 
Type constructEvent payload parameter as Record<string, unknown>.
nicknisi pushed a commit that referenced this pull request Aug 28, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
3b77a62 
Type constructEvent payload parameter as Record<string, unknown>.
nicknisi pushed a commit that referenced this pull request Sep 23, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
66e3740 
Type constructEvent payload parameter as Record<string, unknown>.
nicknisi pushed a commit that referenced this pull request Oct 2, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
5c4b59d 
Type constructEvent payload parameter as Record<string, unknown>.
nicknisi pushed a commit that referenced this pull request Oct 13, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
cb7a3dd 
Type constructEvent payload parameter as Record<string, unknown>.
nicknisi pushed a commit that referenced this pull request Oct 28, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
2d6e2c3 
Type constructEvent payload parameter as Record<string, unknown>.
nicknisi pushed a commit that referenced this pull request Nov 6, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
f9503a9 
Type constructEvent payload parameter as Record<string, unknown>.
nicknisi pushed a commit that referenced this pull request Nov 24, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
e34848e 
Type constructEvent payload parameter as Record<string, unknown>.
nicknisi pushed a commit that referenced this pull request Dec 2, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
017a270 
Type constructEvent payload parameter as Record<string, unknown>.
nicknisi pushed a commit that referenced this pull request Dec 4, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
f59c923 
Type constructEvent payload parameter as Record<string, unknown>.
nicknisi pushed a commit that referenced this pull request Dec 4, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
97f3e61 
Type constructEvent payload parameter as Record<string, unknown>.
nicknisi pushed a commit that referenced this pull request Dec 16, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
19d7edb 
Type constructEvent payload parameter as Record<string, unknown>.
nicknisi pushed a commit that referenced this pull request Dec 22, 2025
@mattgd @nicknisi
Type constructEvent payload parameter as Record<string, unknown> (#1307)
5d601ce 
Type constructEvent payload parameter as Record<string, unknown>.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nicknisi nicknisi nicknisi approved these changes

+1 more reviewer

@greptile-apps greptile-apps[bot] greptile-apps[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@mattgd mattgd

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@mattgd @nicknisi