Configuration
Configuration APIs help your integration discover institute setup and manage webhook subscriptions.
Use these APIs before syncing student, fee, payment, and product data. They provide the stable codes your ERP should use when sending grade, fee component, discount, branch, and webhook configuration details to Jodo.
Master Data
Section titled “Master Data”Master data APIs return configuration maintained for the institute. Use them to map ERP values to Jodo codes.
List Branches
Fetch branch names and collector codes configured for the institute.
Open reference → Configuration APIList Grades
Fetch grade codes and stream information used in student APIs.
Open reference → Configuration APIList Fee Components
Fetch fee component codes used in fee and payment payloads.
Open reference → Configuration APIList Discounts
Fetch discount codes supported for student fee configuration.
Open reference →Webhook Subscriptions
Section titled “Webhook Subscriptions”Webhook subscription APIs let you add, inspect, list, and disable webhook destinations for event codes.
Add Webhook
Add or update a webhook subscription for an event code.
Open reference → Webhook APIList Webhooks
Fetch webhook subscriptions configured for the institute.
Open reference → Webhook APIGet Webhook
Fetch details for a webhook subscription by ID.
Open reference → Webhook APIDisable Webhook
Disable a webhook subscription by ID.
Open reference →Implementation Notes
Section titled “Implementation Notes”- Cache configuration values, but refresh them when institutes change branches, grades, fees, or discount setup.
- Use
collector_codewhen an institute belongs to a group or has branch-specific setup. - Webhook event codes must match the event names documented in product webhook pages.
- Use Webhook Integration for delivery, retry, and security guidance.