Webhook Integration
Webhooks let your system receive real-time updates from Jodo when payments, subscriptions, loans, or manual payment records change state.
Webhook handlers should be designed as background integration points: accept the event quickly, validate that it came from Jodo, store enough context for audit and replay, and process the business update safely.
Recommended Flow
Section titled “Recommended Flow”- Receive the webhook request.
- Verify the request source using a configured header, IP allowlist, or signature verification.
- Persist the event payload and a unique event identifier in your system.
- Return a
2xxresponse once the event is accepted for processing. - Process the event idempotently so retries do not create duplicate records or duplicate state transitions.
- Monitor failures and alerts so integration issues are handled before subscriptions are disabled.
Guides
Section titled “Guides”Reliability
Design handlers for retries, idempotency, timeout behavior, and failure notifications.
Open guide → Webhook IntegrationSecurity
Validate webhook requests using custom headers, IP allowlisting, and signature verification.
Open guide →Response Contract
Section titled “Response Contract”Jodo treats a webhook as delivered when your system returns a successful 2xx HTTP response. Non-2xx responses and timeouts are treated as failed attempts and may be retried according to the retry policy.
Return a success response only after your system has accepted the event. If downstream processing is slow, store the event first and process it asynchronously.