Prerequisites
- A WalletSuite API key, passed as the
x-api-keyheader on every management request (same scheme as the rest of the API). - A publicly reachable HTTPS URL for delivery. Private, internal, and link-local addresses are rejected with
WEBHOOK_URL_NOT_ALLOWED.
Steps
Provision your signing secret
Every delivery is signed with a per-account secret using the Standard Webhooks scheme. Provision it once:The response returns the secret inside the standard
Provision signing secret
{ok, code, message, data} envelope:Response
Calling this endpoint again when a secret already exists returns
409 SIGNING_SECRET_EXISTS. To replace a lost or compromised secret, use POST /api/notifications/signing-secret/rotate instead.Stand up a verifying receiver
Your endpoint receives a
POST, verifies the signature, and acknowledges with a 2xx. With the official standardwebhooks library that is a few lines of code: pass it the raw request body and the Webhook-* headers, and it returns the verified, parsed event.- Node / Express
- Python / FastAPI
- Next.js (App Router)
Install
server.js
Run
Create the subscription
This quickstart subscribes to incoming transfers (The API responds Confirm it is If the subscription does not go
transfer.received) as a worked example - the event catalog lists every event type and its payload. Use an address you control so you can trigger one in the next step. Set chain, the address, both asset-scope filters in eventKinds, and your public webhookUrl:Create subscription
202 Accepted with the subscription. It registers and flips from pending to active within moments:Response
active:Check status
active, see Troubleshooting.Next steps
Verify Signatures
The full Standard Webhooks verification contract - raw-body handling, replay protection, and from-scratch code.
Delivery & Retries
The 18-second ack budget, the retry schedule, at-least-once semantics, and failure handling.
Events & Payloads
Field-by-field payload reference,
transfer.received, Tron address encoding, and payload versioning.Best Practices
Idempotency, async processing, secret rotation, and production hardening for your receiver.