@oneaddress/setup
v1.3.3
Published
Interactive setup wizard for OneAddress partner webhook integrations
Readme
@oneaddress/setup
Interactive setup wizard for OneAddress partner webhook integrations.
Quick start
npx @oneaddress/setupThe wizard:
- Collects your three credentials from the Partner Portal:
- Partner ID (UUID)
- Webhook Secret (HMAC-SHA256)
- ECDH P-256 Private Key PEM
- Asks which platform you want — TypeScript / Python / Go / PHP / Java / C#
- Scaffolds a working webhook server into the directory you choose
- Installs dependencies for that platform
- Starts the server and waits for
/health - Opens a free Cloudflare HTTPS tunnel (or accepts a URL you provide)
- Registers the webhook URL in the Partner Portal
- Runs the conformance check against your live URL
If everything passes, you're integrated.
What you get
A real webhook server (not a toy) with:
- HMAC-SHA256 signature verification (timing-safe via Web Crypto)
- ECDH P-256 + HKDF-SHA256 + AES-256-GCM address decryption
- Replay-window enforcement (±5 min) before signature verify
- Persistent dispatch deduplication
- Address normalisation helper
- For TypeScript: an optional 250-customer demo database with end-to-end matching
Customise the match logic
Open the entry-point file the wizard prints on completion (src/match.ts for ts-node,
app.py for Python, etc.) and replace the demo logic with your real database lookup.
The README inside the scaffolded project walks through the pattern.
Re-run the conformance check
From the Partner Portal → My Profile → Integration Conformance.
Documentation
Issues
Licence
Apache License 2.0. See LICENSE.
Apache-2.0 rather than MIT deliberately: it carries an express patent grant, bounded to this package. OneAddress holds a pending patent application over the address-change notification architecture, and this SDK is the recipient half of it. Partners using it is the entire point, so an explicit, bounded grant is clearer for you than MIT's silence on patents.
