How it works
1
Register an endpoint
Tell Yoshi where to send events by creating a webhook endpoint via the API or the self-service portal. You provide an HTTPS URL and optionally choose which event types to receive.
2
Yoshi detects a change
When a user’s financial data changes — new transactions arrive from their bank, a balance refreshes, or an account is linked — Yoshi generates a webhook event.
3
Your server receives the event
Yoshi sends an HTTP POST to your endpoint with the event payload. Each request is signed so you can verify it came from Yoshi.
4
You respond with 200
Return a
2xx status code within 15 seconds to acknowledge receipt. Process the event asynchronously — don’t do heavy work in the handler.Event envelope
Every webhook event follows the same structure:Webhook payloads contain resource IDs and metadata, not full resource objects. To fetch complete details, call the corresponding API endpoint with the ID from the event. This keeps payloads small and minimizes sensitive data in transit.
Security
Every webhook request includes three headers for signature verification:
Always verify signatures before processing events. The SDKs include a built-in helper that handles verification and replay protection automatically.
Consumer portal
Every API key holder has access to a self-service webhook portal for managing endpoints, viewing delivery logs, and replaying failed events. Generate a portal link via the API:- Create, edit, and delete webhook endpoints
- View delivery attempts with response codes
- Replay failed events with one click
- Browse the event log with full payloads
What’s next
Event catalog
Browse all available event types and their payloads.
Verify signatures
Ensure webhook requests are authentic.
Delivery and retries
Understand retry behavior and idempotency.
Manage endpoints
Register and configure webhook endpoints via the API.