Agent skill
Treezor Webhooks Skill
Receive and verify Treezor webhooks. Use when setting up Treezor webhook handlers, debugging signature verification, or handling BaaS banking events like payin.create, payout.update, cardtransaction.create, wallet.create, or user.kycreview.
Install this skill
npx skills add hookdeck/webhook-skills --skill treezor-webhooks
When to Use This Skill
- How do I receive Treezor webhooks?
- How do I verify the Treezor
object_payload_signature? - Why is my Treezor webhook signature verification failing?
- How do I handle Treezor events like
payin.create,cardtransaction.create, oruser.kycreview? - How do I subscribe to Treezor webhooks via the API?
Verification (core)
Treezor uses a custom HMAC-SHA256 scheme — not Standard Webhooks — and the signature is a field inside the JSON body, not an HTTP header. Webhooks arrive with a text/plain MIME type, so parse the body yourself.
Each body carries object_payload (the object data) and object_payload_signature. To verify, re-serialize object_payload to Treezor's canonical form (the same string PHP's json_encode produces): compact separators, forward slashes escaped (/ → \/), and non-ASCII escaped to lowercase \uXXXX. Then HMAC-SHA256 it with your webhook_secret, base64-encode, and compare timing-safe.
Node:
const crypto = require('crypto');
function canonicalize(objectPayload) {
// Match PHP json_encode: compact, slashes escaped, non-ASCII as \uXXXX
return JSON.stringify(objectPayload)
.replace(/\//g, '\\/')
.replace(/[\u0080-\uffff]/g, (ch) =>
'\\u' + ch.charCodeAt(0).toString(16).padStart(4, '0'));
}
function verify(objectPayload, receivedSignature, secret) {
if (!receivedSignature) return false;
const expected = crypto.createHmac('sha256', secret)
.update(canonicalize(objectPayload), 'utf8')
.digest('base64');
try {
return crypto.timingSafeEqual(Buffer.from(receivedSignature), Buffer.from(expected));
} catch {
return false; // length mismatch = invalid
}
}
Python:
import hmac, hashlib, base64, json
def canonicalize(object_payload) -> str:
# ensure_ascii escapes non-ASCII to \uXXXX; compact separators; escape slashes
return json.dumps(object_payload, ensure_ascii=True, separators=(",", ":")).replace("/", "\\/")
def verify(object_payload, received_signature: str, secret: str) -> bool:
if not received_signature:
return False
expected = base64.b64encode(
hmac.new(secret.encode(), canonicalize(object_payload).encode(), hashlib.sha256).digest()
).decode()
return hmac.compare_digest(received_signature, expected)
Gotcha: The signature is computed over the re-serialized
object_payload, not the raw request body. If your canonical string doesn't byte-match Treezor's (slash escaping,\uXXXXcasing, or key order), verification fails. See references/verification.md.
⚠️ Security: only
object_payloadis signed. The envelope fields —webhook(the event name),webhook_id,objectandobject_id— are outside the signed region and stay untrusted even after verification succeeds. Use them for logging and routing hints only, and derive business state from the verifiedobject_payload(re-fetch from Treezor's API for money-moving or KYC-gated decisions). See references/verification.md.
Response codes: Return 200 on success. Return a 5xx to trigger a retry (Treezor retries every minute, up to 30 attempts). Deliveries are chronological but not order-guaranteed and may be duplicated — dedupe on
webhook_id.
For complete handlers with route wiring, event dispatch, and tests, see:
Common Event Types
Event names follow an object.action pattern, carried in the webhook body field.
| Event | Triggered When |
|---|---|
payin.create | A pay-in (incoming funds) is created |
payin.update | A pay-in changes state |
payout.create | A payout (outgoing SEPA transfer) is created |
payout.update | A payout changes state |
transfer.create | A wallet-to-wallet transfer is created |
transaction.create | A ledger transaction is recorded |
cardtransaction.create | A card authorization/settlement occurs |
card.create | A card is issued |
card.update | A card's status/limits change |
wallet.create | A wallet is opened |
user.create | A user is created |
user.update | A user's data changes |
user.kycreview | A user's KYC review status changes |
Full event reference: Treezor Webhooks documentation. Some objects are camelCase or multi-segment (e.g.
sca.wallet.create,qes.created).
Environment Variables
TREEZOR_WEBHOOK_SECRET=your_webhook_secret # Provided by your Treezor Account Manager
Subscribing to Webhooks
Webhooks are managed on a different host from the main API:
- Production:
https://webhook.api.treezor.co - Sandbox:
https://webhook.sandbox.treezor.co
Subscribe with POST /settings/hooks, then manage which events it receives via /settings/hooks/{uuid}/events. New subscriptions start PENDING and may require Treezor to activate them. See references/setup.md.
Local Development
# Start tunnel (no account needed)
npx hookdeck-cli listen 3000 treezor --path /webhooks/treezor
Reference Materials
- references/overview.md - Treezor webhook concepts and events
- references/setup.md - Subscribe via API, get your webhook secret
- references/verification.md - Signature verification details and gotchas