Repository navigation
Add doc samples for verified sources batch 5 (21 providers) - #74
Merged
Merged
Conversation
Copied from hookdeck/webhook-registry samples-doc/ at 10c5aff3 (rows added in hookdeck/webhook-registry#108): 360dialog, azure-devops, belvo, bringg, copper, currents, doordash-drive, fourkites, hasura, iterable, nium, onelogin, onespan, opsgenie, paxos, pubnub, rev-ai, socure, strapi, stuart, vtex. The other 34 batch 5 rows have no doc sample, so they get no directory. Sample files and index.json files are unchanged from the export. Every non-null topic_identifier resolves all of its provider's samples to their own topic. PubNub's topics are its wire dataSchema values (pubnub.com/schemas/events/<type>?v=1.0.0). The files use the registry harvester's safe stem (pubnub.com.schemas.events.<type>.v.1.0.0.json), as castle, descope and flexport already do; compile keys on each file's `topic` field, so the published topics are the wire values. 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#108 (verified sources batch 5, merged) added 55 provider rows and exported doc examples for 21 of them to the registry's
samples-doc/tree. None of the 21 had a directory here.After: 21 new provider directories with 309 doc-sourced samples.
providers.jsongoes from 272 to 293 providers. The other 34 rows get no directory because they have no published example body: amplitude, apify, aws-eventbridge, bitrise, braze, builder-io, datocms, fireberry, formio, freshsales, hightouch, invoice-ninja, jumpcloud, kobotoolbox, make, new-relic, omnisend, ory, oyster, paperform, paragon, parcellab, prefect, project44, proxyclick, railway, rudderstack, sigfox, speechmatics, tray-io, workato, workspace-one, youcanbookme and zuora. No existing file is changed.topic_identifierlatestentry[].changes[].fieldlatesteventTypelatesteventCodelatestwebhook_typelatestnull(composed:type+.+event)latesteventlatestevent_namelatestMessageTypelatestevent.oplatesteventNamelatesttemplate,rfiDetails.statuslatest[].event_type_idlatestnamelatestactionlatesttypelatestdataSchemalatestnull(no discriminator)latestevent_typelatesteventv3topiclatestStateHow: I copied
samples-doc/providers/<p>/from webhook-registrymain(10c5aff3) intoproviders/, the same way #72 and #73 did. Every file,index.jsonincluded, is byte-identical to the export. Each non-nulltopic_identifierequals the registry row's discriminator path, except nium, whose list adds the row's documented fallback. I checked each one with a port ofresolveTopicagainst every sample, and every non-null one resolves all of its provider's samples to their own topic. Each sample carriessource.type: vendor-documentationand its page URL, and each version is markedsourced_via: docs.yarn compilepasses (272 → 293 providers, and the compiled topic count equals the file count for all 21).yarn testpasses 16/16.Worth a look:
PubNub file names differ from their topics. The topic is the wire
dataSchemavalue, e.g.pubnub.com/schemas/events/channel.created?v=1.0.0. The registry harvester writes the file under a safe stem: runs of characters outside[A-Za-z0-9._-]become.and leading or trailing dots are dropped, givingpubnub.com.schemas.events.channel.created.v.1.0.0.json. Compile keys on each file'stopicfield, so the published keys are the wire values. castle ($list_item.created), descope (Change Password) and flexport (/shipment#created) already ship files named this way.requestReceiver.tsnames a captured filetopic.replace(/[/:\\]/g, "."), which for PubNub would givepubnub.com.schemas.events.channel.created?v=1.0.0.json. That's the same mismatch castle, descope and flexport already have. A live PubNub capture intolatestwould write a second file beside the doc sample rather than overwrite it. Both files would carry the same topic, so whichever compile read last would win. Nothing in the repo reads a file by a name derived from its topic, so this PR leaves the receiver alone.nium uses the README's list form. The registry row's carrier is
templateand its carrier note namesrfiDetails.statusas the fallback.RFI_REQUESTED,RFI_RESPONDEDandRFI_CLOSEDhave notemplateand resolve through the fallback. The list resolves all 74 samples.nullrows: rev-ai has no event field (the registry records the discriminator asabsent). Its one callback is the job's outcome,job.status: failed, and the sample's topic isjob-failed. copper is composed: the registry's carrier note says that neithertypenoreventidentifies the event alone, so the sample's topic isperson.update. This follows shortcut in Add doc samples for verified sources batch 4 (32 providers) #73 and check, jfrog and taiga in Add 228 doc-sourced samples for verified-sources batch 3 (30 providers) #72.onelogin's carrier is an integer.
event_type_idis5on the wire. The body is a top-level array, so[].event_type_idreads the first element, and the topic is"5".Versions taken from the payload: stuart
v3(every body carriesversion: "v3"). This follows the README rule.Not re-versioned:
resourceVersionversions each resource's API representation and differs between samples (1.0,1.0-preview.1,2.0,3.0-preview.1,5.1-preview.1, absent on four).?v=1.0.0is part of each schema identifier, and the registry'sjoin_normalizationstrips it to join the event types. The No Envelope bodies carry no other version.data.workflow_versionis the customer's workflow version.All three stay
latest.hasura keys on
event.op(INSERT,UPDATE,DELETE,MANUAL), as the registry row does. Its carrier note says a receiver serving several triggers routes ontrigger.namefirst.onespan's EDEPOSIT row. The registry notes that the docs table's
EDEPOSIT_FAILURE_ATTEMPTrow has a payload namingEDEPOSIT_ATTEMPT_FAILURE. That row isn't exported. The two eDeposit samples here areEDEPOSIT_FAILUREandEDEPOSIT_SUCCESS, and each body'snamematches its topic.strapi also sends the event name in
X-Strapi-Event, and the sample carries that header.eventin the body is the registry's carrier, and both values agree.Generated by Claude Code