Repository navigation
Add 147 doc-sourced samples for the verified-sources pilot (10 providers) - #68
Merged
Merged
Conversation
Copied unchanged from hookdeck/webhook-registry samples-doc/ at 7e60bde1 (rows added in hookdeck/webhook-registry#100): attio, cal-com, clickup, line, mux, quickbooks, reducto, render, shippo, sumsub. Etsy has a registry row but no doc sample, so it gets no directory. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01D7eqaQdKAUzQXRbGtym1PF
An empty segment name before [] now means the current value, so "[].type" reads body[0].type for a body that is itself an array. QuickBooks' CloudEvents deliveries (and Helius') are root arrays, and their registry discriminator "[].type" previously resolved to nothing, leaving a capture as untitled-<hash>. Adds two topic.test.ts cases and a row to the README's identifier table. Across every provider in this branch, the only resolve count that changes is quickbooks, from 0/1 to 1/1. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01D7eqaQdKAUzQXRbGtym1PF
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
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
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.
Requested by Gareth · project thread
Before: hookdeck/webhook-registry#100 (the verified-sources pilot, merged) added 11 provider rows and exported their doc examples to the registry's
samples-doc/tree. None of those providers had a directory here, so Console had no example webhooks for them.After: 10 new provider directories with 147 doc-sourced samples.
providers.jsongoes from 155 to 165 providers. Etsy has a registry row but no published example body, so it gets no directory. No existing file is changed.topic_identifierlatestevents[].event_type2021-10-20triggerEventlatesteventlatestevents[].typelatesttypelatest[].typelatestnull(no discriminator)latesttypelatesteventlatesttypeHow: I copied
samples-doc/providers/<p>/from webhook-registrymain(7e60bde1) intoproviders/, the same way #65 to #67 did. Nothing in this batch needed changing: everyindex.jsonand every sample file is byte-identical to the export. Eachtopic_identifierequals the registry row's discriminator path. I checked each one with a port ofresolveTopic: it resolves to the file'stopicin every sample except quickbooks and reducto (see below). Each file carriessource.type: vendor-documentationand its page URL, and each version is markedsourced_via: docs.yarn compilepasses (155 → 165 providers, compiled topic count equals file count for all 10).yarn testpasses 14/14.Worth a look:
[].type: the body is a root-level JSON array.resolveTopiccan't read a leading[], so a future capture would be filed asuntitled-<hash>. I kept the accurate path, as sparkpost's[].msys.*.typedid in feat: add 57 doc-sourced samples for aftership, circleci, docker-hub, grafana, snipcart, sparkpost + checkout Identity Verification #58.null: the registry records no discriminator (location: absent). This follows the docker-hub and deepgram convention, and the file's owntopicnames it.2021-10-20, the payload version they were documented under (sent asx-cal-webhook-version). Cal.com also documents2026-07-27, which is additive, but the vendor truncates that tab's examples, so none were exported.latest_versionpoints at the directory that has data.events[]envelope) bodies are included. The registry records V1 framing as undocumented.Update (e4b88ce):
resolveTopicnow treats an empty name before[]as the current value, so[].typereadsbody[0].typefrom a root-level array. This adds twotopic.test.tscases and a row to the README's identifier table. quickbooks now resolves 1/1 (was 0/1), and helius in #70 resolves 1/1 once this merges. I re-ran every provider through the resolver, and quickbooks is the only count that changed. I didn't add the legacy QuickBooks path (eventNotifications[].dataChangeEvent.entities[].name): it resolves 0 of 1 sample, because the only published example is the CloudEvents array, sotopic_identifierstays"[].type".yarn compilepasses andyarn testpasses 16/16.Generated by Claude Code