docs(listener): add API usage cookbook with workflow examples (#139)#149
Merged
Abd-Standard merged 1 commit intoJun 22, 2026
Conversation
…ore-Foundry#139) Adds listener/API_USAGE_COOKBOOK.md — a workflow-oriented companion to listener/API.md that demonstrates how to combine endpoints to ship common integrations: * Workflow 1 — stream live contract events (curl + jq tail, polling loop) * Workflow 2 — schedule a future notification (Discord reminders, chained events) * Workflow 3 — accept signed webhooks (HMAC-SHA256 signing from bash and Node.js) * Workflow 4 — manage per-user notification preferences (patch-style updates) * Workflow 5 — health-check a deployment (K8s readiness probe, dependency dump) * Workflow 6 — diagnose a failing request (X-Request-Id / X-Correlation-Id) * Workflow 7 — recover from a Discord outage (detection, re-queue, prevention) * Troubleshooting matrix and one-page field reference Cross-linked from listener/INSTALLATION.md so the cookbook is discoverable from the install path. Issue: Core-Foundry#139 Signed-off-by: zeroknowledge0x <zeroknowledge0x@users.noreply.github.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
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.
Closes #139
Summary
Adds a workflow-oriented companion to
listener/API.mdthat demonstrates how to combine endpoints to ship common integrations. Each workflow has a curl one-liner, an expected response shape, and a follow-on command so contributors can copy-paste-test against a running listener.Workflows covered
curl + jq tailpolling loopPlus a Troubleshooting matrix (symptom → cause → fix) and a one-page field reference for the most common JSON envelopes.
Files changed
listener/API_USAGE_COOKBOOK.md— new file, +558 lines, 7 workflows + troubleshooting + field referencelistener/INSTALLATION.md— +5 lines, cross-link from install path so the cookbook is discoverableAcceptance criteria mapping
How to verify locally
All 7 workflows use only the documented listener API surface — no undocumented endpoints.
Cross-links
The cookbook is discoverable from
listener/INSTALLATION.md(Step 6 → 'See API_USAGE_COOKBOOK.md for end-to-end workflow examples') so contributors who finish install can immediately try the workflows.Labels
This issue carries the GrantFox triple label (
Maybe Rewarded+GrantFox OSS+Official Campaign). Happy to follow any additional GrantFox claim workflow after merge.Signed-off-by: zeroknowledge0x zeroknowledge0x@users.noreply.github.com