From 8913e6f41324531dc1ccf5cd86d2b9990dae773b Mon Sep 17 00:00:00 2001 From: Phil Leggetter Date: Tue, 3 Nov 2026 23:22:43 +0000 Subject: [PATCH 1/2] docs: describe Inspect as the consumer of the samples data The intro named only Hookdeck Console's Example Webhooks. The data now also powers the mock webhooks in Hookdeck Inspect. Also notes that most samples are doc-sourced, fixes a stray backtick in the install step, and points the example URL at Shopify's current version. Co-Authored-By: Claude Opus 5.5 --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c2dd5277..27454d82 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,15 @@ # Webhook Samples -This repo is a collection of webhooks data from different platforms that distribute webhooks. This data is used in https://console.hookdeck.com "Example Webhooks". +Example webhook requests (headers and body, one file per event topic) for the +providers in [`providers/`](./providers). The data is published to +https://samples.hookdeck.com and powers the mock webhooks in +[Hookdeck Inspect](https://inspect.hookdeck.com). It also backs "Example +Webhooks" in [Hookdeck Console](https://console.hookdeck.com). + +Most samples are transcribed from each provider's published documentation; +a smaller set are captured from real deliveries. Every version records which, +in its `provenance` (see [Doc-sourced samples](#doc-sourced-samples)), and +`providers.json` publishes it so consumers can tell them apart. ## Contributing @@ -110,7 +119,7 @@ Both fields are published per version in `providers.json`. A version with no entry is published as `unknown`, never as a claim that it was captured. An unrecognised `sourced_via` fails the build. -3. [OPTIONAL] Install the dependencies with `yarn` install` and start the request receiver with `yarn dev:receiver`. You can now send a request to http://localhost:9001/:provider/:version, and the received request will automatically be saved to that provider directory. +3. [OPTIONAL] Install the dependencies with `yarn install` and start the request receiver with `yarn dev:receiver`. You can now send a request to http://localhost:9001/:provider/:version, and the received request will automatically be saved to that provider directory. Each provider has a directory for each version, and each version has a file for each topic. The file's name is the topic and contains the request data `headers` and `body`. @@ -158,5 +167,8 @@ They come from [hookdeck/webhook-registry](https://github.com/hookdeck/webhook-r The data is packaged into JSON files that are distributed over http. The files can be found on https://samples.hookdeck.com -List of providers: https://samples.hookdeck.com/providers.json -Data for a provider: https://samples.hookdeck.com/providers/shopify/2023-01.json +- **List of providers:** https://samples.hookdeck.com/providers.json, keyed by + provider slug, with each provider's `label`, `latest_version`, `versions` and + per-version `provenance`. +- **Data for a provider version:** `https://samples.hookdeck.com/providers/:provider/:version.json`, + for example https://samples.hookdeck.com/providers/shopify/2026-07.json. From 3ca65c79273fe65742cf0c0899a36932a9b86864 Mon Sep 17 00:00:00 2001 From: Phil Leggetter Date: Wed, 4 Nov 2026 09:46:37 +0000 Subject: [PATCH 2/2] docs: drop the Console reference, Inspect is the consumer Co-Authored-By: Claude Opus 5.5 --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 27454d82..5e9c5330 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,7 @@ Example webhook requests (headers and body, one file per event topic) for the providers in [`providers/`](./providers). The data is published to https://samples.hookdeck.com and powers the mock webhooks in -[Hookdeck Inspect](https://inspect.hookdeck.com). It also backs "Example -Webhooks" in [Hookdeck Console](https://console.hookdeck.com). +[Hookdeck Inspect](https://inspect.hookdeck.com). Most samples are transcribed from each provider's published documentation; a smaller set are captured from real deliveries. Every version records which,