feat(webhooks): recognize webhook.setup verification event#31
Merged
Conversation
Vatly's webhook endpoint verification ("setup") call is now delivered as a
standard WebhookEvent envelope (eventName `webhook.setup`, entityType `webhook`)
rather than a bespoke body, so it parses through `Webhook::parse()` like any
other event — no special-casing on the receiver.
- Add `WebhookEventName::WEBHOOK_SETUP`
- Document the event + that receivers should simply 2xx-ack it
- Test that the setup envelope parses to a normal WebhookPayload
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
Vatly sends a signed endpoint verification ("setup") call when a webhook endpoint is registered or its URL changes. It is now delivered as a standard
WebhookEventenvelope (eventName: webhook.setup,entityType: webhook) instead of a bespoke{message, testmode}body.This lets the SDK parse it through
Webhook::parse()like any other event — no special-casing, no polymorphic return type. Receivers simply acknowledge it with a 2xx and take no action.Changes
WebhookEventName::WEBHOOK_SETUP(webhook.setup).docs/Webhooks.md(it's a normal event; just 2xx-ack it).WebhookPayload.Notes
parse()itself needed no change — it already returns a singleWebhookPayloadand validates the standard required fields.WebhookSetupCallPayload); fixing the wire format at the source is cleaner.🤖 Generated with Claude Code