Prerequisites
- A Paxos Labs organization with admin access
- A publicly reachable HTTPS server (or a tunnel like ngrok for local development)
Step 1: Create a Webhook Endpoint
1
Open the Paxos Labs Console
Navigate to your organization in the Paxos Labs Console and select the Webhooks tab.
2
Add an endpoint
Click Add Endpoint. Enter your HTTPS URL, an optional display name, and select the event types you want to receive.
3
Save your signing secret
After creation, a signing secret starting with
pxlwh_ is displayed once. Copy it immediately and store it in your secrets manager (e.g., AWS Secrets Manager, Vault, or .env for local development).Step 2: Build a Receiver
Create a minimal HTTP server that acceptsPOST requests, verifies the signature, and responds with 200 OK.
- Node.js
- Python
- Go
Step 3: Expose Your Local Server
For local development, use a tunnel so Paxos Labs can reach your machine:https:// URL and use it as your webhook endpoint URL in the Paxos Labs Console.
Step 4: Send a Test Event
Back in the Paxos Labs Console, expand your endpoint row and click Send Test. Choose ping to fire a lightweight connectivity check. Your server should log output like:Step 5: Subscribe to Events
Edit your endpoint to add event types likedirect_transfer.deposit.pending, direct_transfer.deposit.confirmed, or direct_transfer.deposit.failed. When those events occur in your organization, your server will receive them automatically.
Next Steps
Signature Verification
Deep dive into the HMAC-SHA256 signature scheme, replay protection, and production best practices.
Event Catalog
Full reference of every event type with payload schemas and field descriptions.