chore: change webhook back to object #7461
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
🦋 Changeset detectedLatest commit: ede38a2 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
WalkthroughThis change updates the webhook event structure in the Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant WebhookEventProducer
participant KafkaProducer
Client->>WebhookEventProducer: sendEvents({ teamId, data, ... })
WebhookEventProducer->>WebhookEventProducer: Validate teamId, projectId, etc.
WebhookEventProducer->>KafkaProducer: Send event with data as object
Possibly related PRs
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ Context from checks skipped due to timeout of 90000ms (8)
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. This stack of pull requests is managed by Graphite. Learn more about stacking. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7461 +/- ##
=======================================
Coverage 51.92% 51.92%
=======================================
Files 947 947
Lines 63932 63932
Branches 4216 4216
=======================================
Hits 33194 33194
Misses 30632 30632
Partials 106 106
🚀 New features to boost your workflow:
|
size-limit report 📦
|
arcoraven
force-pushed
the
ph/06-28-chore_change_webhook_back_to_object
branch
from
6e7b663 to
ede38a2
Compare
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[Service-Utils] Fix: Update webhook payload structure
Notes for the reviewer
This PR updates the webhook event schema to use a single
dataobject instead of an array of objects in thepayloadfield. This change aligns with the webhook documentation referenced in the code comment.Key changes:
payloadfield todatain theWebhookEventinterfaceRecord<string, unknown>[]toRecord<string, unknown>How to test
Verify that webhook events are properly structured with the new schema when produced.
Summary by CodeRabbit
PR-Codex overview
This PR focuses on updating the
WebhookEventinterface in theservice-utilspackage to change thepayloadproperty todataand modify its structure, as well as enhancing the documentation for webhook events.Detailed summary
payloadtodatain theWebhookEventinterface.datafromRecord<string, unknown>[]toRecord<string, unknown>.payloadmust not be empty in thesendEventsmethod.