Repository navigation
Add 228 doc-sourced samples for verified-sources batch 3 (30 providers) - #72
Merged
Merged
Conversation
Copied from hookdeck/webhook-registry samples-doc/ at 5a396b63 (rows added in hookdeck/webhook-registry#105): ably, acuity-scheduling, bird, bland-ai, boldsign, census, check, cloudtalk, codat, descope, doppler, firecrawl, firehydrant, flagsmith, go1, granola, help-scout, jfrog, kit, kombo, kustomer, loop-returns, mailerlite, seatable, stedi, taiga, terraform, toggl, waha, yapily. The other 15 batch 3 rows have no doc sample, so they get no directory. Sample files are unchanged. Two index.json files differ from the export: - mailerlite: topic_identifier is the README's ordered list form (event, type, events[].type), one carrier per registry family. The export's "event" resolved 7 of 14 samples; the list resolves all 14. - terraform: topic_identifier is ["notifications[].trigger", "trigger"], the registry row's primary (run, payload_version 1) carrier then the workspace/assessment (payload_version 2) one. The export keyed on the second family's "trigger" alone, which resolved 2 of 4 samples; the list resolves all 4. 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#105 (verified sources batch 3, merged) added 44 provider rows, upgraded Smartsheet's, and exported doc examples for 30 of those 45 to the registry's
samples-doc/tree. None of the 30 had a directory here.After: 30 new provider directories with 228 doc-sourced samples.
providers.jsongoes from 210 to 240 providers. The other 15 rows have no published example body, so they get no directory: breezy-hr, checkly, duffel, exa, expo, fourthwall, gitea, heygen, lago, luma, mautic, propelauth, sendcloud, smartsheet and vgs. No existing file is changed. This touches only new directories.topic_identifierlatestitems[].sourcelatestactionlatesttypelatestevent_typelatestevent.eventTypelatesteventlatestnull(composed:Check-Topic+.+event)v1typelatesteventTypelatest[].actionlatesttypev2typelatestevent.resource_typelatestevent_type3.0.0event_typelatestevent_typelatestx-helpscout-event(header)latestnull(composed:domain+.+event_type)latestevents[].typelatesttypelatestnamelatesttriggerlatestevent,type,events[].typelatestdata.op_typev1typelatestnull(composed:type+.+action)latestnotifications[].trigger,triggerv1null(no discriminator)latesteventlatesttypeHow: I copied
samples-doc/providers/<p>/from webhook-registrymain(5a396b63) intoproviders/, the same way #70 did. Every sample file is byte-identical to the export. Twoindex.jsonfiles differ, and those changes are listed first below. I checked eachtopic_identifierwith a port ofresolveTopicagainst every sample, and every non-null one resolves all of its provider's samples. Each file carriessource.type: vendor-documentationand its page URL, and each version is markedsourced_via: docs.yarn compilepasses (210 → 240 providers, compiled topic count equals file count for all 30).yarn testpasses 16/16.Worth a look:
event, which resolved 7 of 14 samples. The registry row records three carrier families (event,type, batchedevents[].type), and the automation, group, campaign-click/open and delete bodies carrytypeinstead ofevent. Listing them in registry order resolves all 14 (unipile and veriff precedent).notifications[].trigger(run notifications,payload_version1), with top-leveltriggerfor workspace and assessment notifications (payload_version2). The export keyed on the second family'striggeralone, which resolved 2 of 4 (run:erroredandverificationwere missed). The list resolves all 4.null: check, jfrog and taiga, as exported. This follows the modern-treasury, stytch and webex precedent from Add 186 doc-sourced samples for verified-sources batch 2 (26 providers) #70. toggl isnullbecause the registry records no discriminator (its one sample is theping).v1(bodyversion), stediv1("object": "v1.event", theeventPayload.v1Eventschema) and go13.0.0(bodywebhook_version). These follow the README rule.v2: there's no version field in the payload or headers. The registry files it underv2only because the webhook object is documented on the/v2/endpoints.v1: the registry saysversioned: false. Thev1is the Webhooks API path (/webhooks/api/v1), and the docs URL carries no version. In Add 186 doc-sourced samples for verified-sources batch 2 (26 providers) #70, ramp stayedlatestfor the same reason, so going by that, toggl should belatest. It's a one-line change plus a directory move.latest: every delivery sends anx-ably-version: 1.2header, which the docs call "the version of the Webhook". The README rule names payload fields, so I left it atlatest. Following the castle precedent, it would be1.2.latest: its bodies carrypayload_version1and2. These mark two notification shapes that are both current, so they aren't successive versions. Splitting them would hide one shape behind a non-latest directory.event_type, not the registry's primarycategory. The registry recordscategory, thenevent_type. The one sample (citations) carries onlyevent_type, socategoryalone would resolve 0 of 1. It stays as exported, like didit in Add 186 doc-sourced samples for verified-sources batch 2 (26 providers) #70, where every sample resolves.["category", "event_type"]would match the row and is a one-line change. ably and codat also have unlisted extra families, but all of their samples resolve, so they stay strings.Change Password(spaces on the wire), kombo's isassessment:order-received, and terraform's triggers use:(run:errored,assessment:drifted,workspace:auto_destroy_reminder). The files areChange.Password.json,assessment.order-received.json,run.errored.jsonand so on, but the published topic keys come from each file'stopicfield and match the wire values.[].actionis a root-level array. It resolves now that the resolver fix from Add 147 doc-sourced samples for the verified-sources pilot (10 providers) #68 is merged.fivetran.comdocs, because Census is now part of Fivetran.Generated by Claude Code