PaadamപാഠംGuides

For developers

API

Read and change your institute's people, courses, classes, fees and more from your own systems.

Address and keys

The API lives at your institute's address, under /api:

https://learn.yourschool.in/api/v1/courses

Make a key in Settings → Developers and send it in the Authorization header:

curl https://learn.yourschool.in/api/v1/members?roles=learner \
  -H "Authorization: Bearer pdk_…"
  • A key acts as the staff member who made it, and stops working if they stop being staff.
  • Some things need a person signed in, never a key: adding or changing owners and admins, connected services, your own address, your Paadam plan, your data, and API keys themselves.
  • Read-only keys can only use GET.
  • Each key can make 600 requests a minute.
  • Keys are shown once. Revoke one in Settings and it stops at once.

Errors

Errors are JSON with an HTTP status to match:

{ "error": { "code": "validation_failed", "message": "Enter a valid phone number",
             "details": { "fields": [{ "path": "phone", "message": "Enter a valid phone number" }] } } }

The OpenAPI description

The full machine-readable description is at /api/v1/openapi.json on your address: import it into Postman, Insomnia or a code generator. Every endpoint is listed below.

People

get/v1/membersList people

Learners, parents, tutors and staff, filtered by role or searched by name, phone or email.

Query

rolesstring
qstring
pageinteger
pageSizeinteger

Answer

FieldType
itemsrequiredlist of object
totalrequiredinteger
pagerequiredinteger
pageSizerequiredinteger
countsrequiredobject
post/v1/membersAdd a person

Adds someone with one role. Someone already here with the same phone or email (and name) gets the role added instead of a duplicate.

Body

FieldType
namerequiredstring
emailstring
phonestring
rolerequiredone of: "owner", "admin", "tutor", "learner", "parent"
passwordstring

Answer

FieldType
idrequiredstring (uuid)
namerequiredstring
emailrequiredstring or null
phonerequiredstring or null
rolesrequiredlist of one of: "owner", "admin", "tutor", "learner", "parent"
statusrequiredone of: "active", "suspended"
createdAtrequiredstring
lastLoginAtrequiredstring or null
get/v1/members/{id}One person

Answer

FieldType
idrequiredstring (uuid)
namerequiredstring
emailrequiredstring or null
phonerequiredstring or null
rolesrequiredlist of one of: "owner", "admin", "tutor", "learner", "parent"
statusrequiredone of: "active", "suspended"
createdAtrequiredstring
lastLoginAtrequiredstring or null
tagsrequiredlist of string
profilerequiredobject
languagerequiredstring or null
parentsrequiredlist of object
childrenrequiredlist of object
learningrequiredlist of object
teachingrequiredlist of object
blockedFromPostingrequiredboolean
patch/v1/members/{id}Change a person's details

Body

FieldType
namestring
emailstring or null
phonestring or null
tagslist of string
profileobject
languageone of: "en", "ml" or null
statusone of: "active", "suspended"

Answer

FieldType
idrequiredstring (uuid)
namerequiredstring
emailrequiredstring or null
phonerequiredstring or null
rolesrequiredlist of one of: "owner", "admin", "tutor", "learner", "parent"
statusrequiredone of: "active", "suspended"
createdAtrequiredstring
lastLoginAtrequiredstring or null
tagsrequiredlist of string
profilerequiredobject
languagerequiredstring or null
parentsrequiredlist of object
childrenrequiredlist of object
learningrequiredlist of object
teachingrequiredlist of object
blockedFromPostingrequiredboolean
post/v1/members/importAdd many people at once

Up to a few thousand rows; set dryRun to check them first. Can put learners straight into a course.

Body

FieldType
rowsrequiredlist of object
courseIdstring (uuid)
dryRunboolean

Answer

FieldType
createdrequiredinteger
updatedrequiredinteger
enrolledrequiredinteger
parentsLinkedrequiredinteger
errorsrequiredlist of object
notesrequiredlist of object
dryRunrequiredboolean

Courses

get/v1/coursesList courses

Answer

FieldType
itemsrequiredlist of object
post/v1/coursesCreate a course

Body

FieldType
titlerequiredstring
kindone of: "group", "one_to_one", "recorded"
descriptionstring or null
colorstring or null
maxLearnersinteger or null
admissionsOpenboolean
startsOnstring or null
endsOnstring or null
defaultProviderone of: "google_meet", "zoom", "external", "in_person", "paadam_live"
defaultDurationMininteger
defaultLocationstring or null
defaultExternalUrlstring (uri) or null
whatsappGroupIdstring or null
shareRecordingsboolean
certificateobject
tutorIdslist of string (uuid)

Answer

FieldType
idrequiredstring (uuid)
titlerequiredstring
kindrequiredone of: "group", "one_to_one", "recorded"
statusrequiredone of: "active", "archived"
descriptionrequiredstring or null
colorrequiredstring or null
maxLearnersrequiredinteger or null
admissionsOpenrequiredboolean
startsOnrequiredstring or null
endsOnrequiredstring or null
defaultProviderrequiredone of: "google_meet", "zoom", "external", "in_person", "paadam_live"
defaultDurationMinrequiredinteger
defaultLocationrequiredstring or null
defaultExternalUrlrequiredstring or null
whatsappGroupIdrequiredstring or null
shareRecordingsrequiredboolean
certificaterequiredobject
createdAtrequiredstring
tutorsrequiredlist of object
learnerCountrequiredinteger
nextClassAtrequiredstring or null
get/v1/courses/{id}One course

Answer

FieldType
idrequiredstring (uuid)
titlerequiredstring
kindrequiredone of: "group", "one_to_one", "recorded"
statusrequiredone of: "active", "archived"
descriptionrequiredstring or null
colorrequiredstring or null
maxLearnersrequiredinteger or null
admissionsOpenrequiredboolean
startsOnrequiredstring or null
endsOnrequiredstring or null
defaultProviderrequiredone of: "google_meet", "zoom", "external", "in_person", "paadam_live"
defaultDurationMinrequiredinteger
defaultLocationrequiredstring or null
defaultExternalUrlrequiredstring or null
whatsappGroupIdrequiredstring or null
shareRecordingsrequiredboolean
certificaterequiredobject
createdAtrequiredstring
tutorsrequiredlist of object
learnerCountrequiredinteger
nextClassAtrequiredstring or null
patch/v1/courses/{id}Change a course

Body

FieldType
titlestring
kindone of: "group", "one_to_one", "recorded"
descriptionstring or null
colorstring or null
maxLearnersinteger or null
admissionsOpenboolean
startsOnstring or null
endsOnstring or null
defaultProviderone of: "google_meet", "zoom", "external", "in_person", "paadam_live"
defaultDurationMininteger
defaultLocationstring or null
defaultExternalUrlstring (uri) or null
whatsappGroupIdstring or null
shareRecordingsboolean
certificateobject
statusone of: "active", "archived"

Answer

FieldType
idrequiredstring (uuid)
titlerequiredstring
kindrequiredone of: "group", "one_to_one", "recorded"
statusrequiredone of: "active", "archived"
descriptionrequiredstring or null
colorrequiredstring or null
maxLearnersrequiredinteger or null
admissionsOpenrequiredboolean
startsOnrequiredstring or null
endsOnrequiredstring or null
defaultProviderrequiredone of: "google_meet", "zoom", "external", "in_person", "paadam_live"
defaultDurationMinrequiredinteger
defaultLocationrequiredstring or null
defaultExternalUrlrequiredstring or null
whatsappGroupIdrequiredstring or null
shareRecordingsrequiredboolean
certificaterequiredobject
createdAtrequiredstring
tutorsrequiredlist of object
learnerCountrequiredinteger
nextClassAtrequiredstring or null
get/v1/courses/{id}/learnersA course's learners

Answer

FieldType
itemsrequiredlist of object
post/v1/courses/{id}/learnersAdd learners to a course

Body

FieldType
userIdsrequiredlist of string (uuid)
expiresAtstring (date-time) or null

Answer

FieldType
addedrequiredinteger
get/v1/courses/{id}/learners/{userId}/removalWhat removing a learner would do to their fees

Which of their orders would stop (with what's still due, and the last payment refund=1 would give back) and which would go on. Owners and admins. Changes nothing.

Answer

FieldType
stoppingOrdersrequiredlist of object
continuingOrdersrequiredlist of object
refundablePaiserequiredinteger
delete/v1/courses/{id}/learners/{userId}Remove a learner from a course

Also stops what they pay for it: an order for this course alone is cancelled (what's still due, and its autopay). A bundle that covers other courses they're still in keeps billing. Nothing is refunded unless refund=1: then the last payment on each order that stops is refunded (through the gateway, or recorded as given back when it was paid offline), and each stopped order says how that went: done, pending (the gateway hasn't confirmed; refunding the payment again finishes it) or failed (with the reason). Never a bundle's that goes on.

Query

refundone of: "0", "1"

Answer

FieldType
stoppedOrdersrequiredlist of object
continuingOrdersrequiredlist of object
noterequiredstring or null

Classes

get/v1/classesClasses between two times

Query

fromstring (date-time)
tostring (date-time)
courseIdstring (uuid)
tutorIdstring (uuid)
learnerIdstring (uuid)
statusone of: "scheduled", "live", "completed", "cancelled"

Answer

FieldType
itemsrequiredlist of object
post/v1/classesSchedule a class

Checks clashes (tutor busy or on leave, holidays, learners in two places) unless force is set.

Body

FieldType
courseIdrequiredstring (uuid)
titlerequiredstring
descriptionstring or null
tutorIdstring (uuid) or null
providerone of: "google_meet", "zoom", "external", "in_person", "paadam_live"
locationstring or null
joinUrlstring (uri) or null
durationMininteger
startsAtrequiredstring (date-time)
forceboolean

Answer

FieldType
idrequiredstring (uuid)
courseIdrequiredstring (uuid)
courseTitlerequiredstring
courseColorrequiredstring or null
seriesIdrequiredstring (uuid) or null
tutorrequiredobject or null
titlerequiredstring
descriptionrequiredstring or null
startsAtrequiredstring
endsAtrequiredstring
statusrequiredone of: "scheduled", "live", "completed", "cancelled"
providerrequiredone of: "google_meet", "zoom", "external", "in_person", "paadam_live"
joinUrlrequiredstring or null
locationrequiredstring or null
startedAtrequiredstring or null
endedAtrequiredstring or null
cancelReasonrequiredstring or null
attendancerequiredobject or null
myAttendancerequiredone of: "present", "late", "absent", "excused" or null
hasReportrequiredboolean
recordingCountrequiredinteger
post/v1/class-seriesSchedule repeating classes

Body

FieldType
courseIdrequiredstring (uuid)
titlestring
numberFrominteger
weekdaysrequiredlist of integer
startTimerequiredstring
durationMinrequiredinteger
startsOnrequiredstring
endsOnstring or null
occurrencesinteger or null
tutorIdstring (uuid) or null
providerone of: "google_meet", "zoom", "external", "in_person", "paadam_live"
locationstring or null
joinUrlstring (uri) or null
skipHolidaysboolean
forceboolean

Answer

FieldType
seriesIdrequiredstring (uuid)
createdrequiredinteger
skippedHolidaysrequiredlist of string
skippedPastrequiredlist of string
conflictsrequiredlist of object
post/v1/class-series/{id}/cancelCancel the rest of a series

Body

FieldType
fromstring (date-time)
reasonstring
notifyboolean

Answer

FieldType
cancelledrequiredinteger
get/v1/classes/{id}One class

Answer

FieldType
idrequiredstring (uuid)
courseIdrequiredstring (uuid)
courseTitlerequiredstring
courseColorrequiredstring or null
seriesIdrequiredstring (uuid) or null
tutorrequiredobject or null
titlerequiredstring
descriptionrequiredstring or null
startsAtrequiredstring
endsAtrequiredstring
statusrequiredone of: "scheduled", "live", "completed", "cancelled"
providerrequiredone of: "google_meet", "zoom", "external", "in_person", "paadam_live"
joinUrlrequiredstring or null
locationrequiredstring or null
startedAtrequiredstring or null
endedAtrequiredstring or null
cancelReasonrequiredstring or null
attendancerequiredobject or null
myAttendancerequiredone of: "present", "late", "absent", "excused" or null
hasReportrequiredboolean
recordingCountrequiredinteger
reportrequiredobject or null
myRatingrequiredinteger or null
ratingSummaryrequiredobject or null
canRaterequiredboolean
patch/v1/classes/{id}Move or change a class

Body

FieldType
titlestring
descriptionstring or null
tutorIdstring (uuid) or null
providerone of: "google_meet", "zoom", "external", "in_person", "paadam_live"
locationstring or null
joinUrlstring (uri) or null
startsAtstring (date-time)
durationMininteger
forceboolean

Answer

FieldType
idrequiredstring (uuid)
courseIdrequiredstring (uuid)
courseTitlerequiredstring
courseColorrequiredstring or null
seriesIdrequiredstring (uuid) or null
tutorrequiredobject or null
titlerequiredstring
descriptionrequiredstring or null
startsAtrequiredstring
endsAtrequiredstring
statusrequiredone of: "scheduled", "live", "completed", "cancelled"
providerrequiredone of: "google_meet", "zoom", "external", "in_person", "paadam_live"
joinUrlrequiredstring or null
locationrequiredstring or null
startedAtrequiredstring or null
endedAtrequiredstring or null
cancelReasonrequiredstring or null
attendancerequiredobject or null
myAttendancerequiredone of: "present", "late", "absent", "excused" or null
hasReportrequiredboolean
recordingCountrequiredinteger
post/v1/classes/{id}/cancelCancel a class

Learners and parents are told on the institute's channels.

Body

FieldType
reasonstring
notifyboolean

Answer

FieldType
idrequiredstring (uuid)
courseIdrequiredstring (uuid)
courseTitlerequiredstring
courseColorrequiredstring or null
seriesIdrequiredstring (uuid) or null
tutorrequiredobject or null
titlerequiredstring
descriptionrequiredstring or null
startsAtrequiredstring
endsAtrequiredstring
statusrequiredone of: "scheduled", "live", "completed", "cancelled"
providerrequiredone of: "google_meet", "zoom", "external", "in_person", "paadam_live"
joinUrlrequiredstring or null
locationrequiredstring or null
startedAtrequiredstring or null
endedAtrequiredstring or null
cancelReasonrequiredstring or null
attendancerequiredobject or null
myAttendancerequiredone of: "present", "late", "absent", "excused" or null
hasReportrequiredboolean
recordingCountrequiredinteger
get/v1/classes/{id}/attendanceA class's attendance

Answer

FieldType
itemsrequiredlist of object
put/v1/classes/{id}/attendanceMark attendance

Body

FieldType
entriesrequiredlist of object

Answer

FieldType
itemsrequiredlist of object
get/v1/courses/{id}/recordingsA course's recordings

Answer

FieldType
itemsrequiredlist of object
post/v1/courses/{id}/recordingsAdd a recording

Body

FieldType
titlerequiredstring
urlrequiredstring (uri)
sessionIdstring (uuid) or null
publishedboolean

Answer

FieldType
idrequiredstring (uuid)
courseIdrequiredstring (uuid)
sessionIdrequiredstring (uuid) or null
sessionStartsAtrequiredstring or null
titlerequiredstring
providerrequiredone of: "google_drive", "zoom", "vimeo", "youtube", "bunny", "link", "paadam"
urlrequiredstring
durationSecondsrequiredinteger or null
statusrequiredone of: "processing", "ready", "failed"
publishedrequiredboolean
notesrequiredone of: "queued", "processing", "ready", "failed" or null
resumerequiredobject or null
createdAtrequiredstring

Sales and fees

get/v1/ordersList orders

Query

statusone of: "pending", "active", "paid", "cancelled", "refunded"
qstring
productIdstring (uuid)
userIdstring (uuid)
fromstring (date)
tostring (date)
pageinteger
pageSizeinteger

Answer

FieldType
itemsrequiredlist of object
totalrequiredinteger
post/v1/ordersSell something by hand

A walk-in or a phone sale, optionally with its first payment.

Body

FieldType
userIdrequiredstring (uuid)
planIdrequiredstring (uuid)
couponCodestring or null
extraDiscountPaiseinteger
notestring or null
firstPaymentobject or null

Answer

FieldType
idrequiredstring (uuid)
numberrequiredinteger
statusrequiredone of: "pending", "active", "paid", "cancelled", "refunded"
userrequiredobject
productIdrequiredstring (uuid) or null
productTitlerequiredstring
planNamerequiredstring
planKindrequiredone of: "one_time", "instalments", "subscription"
subtotalPaiserequiredinteger
discountPaiserequiredinteger
walletPaiserequiredinteger
totalPaiserequiredinteger
paidPaiserequiredinteger
balancePaiserequiredinteger
couponCoderequiredstring or null
affiliaterequiredstring or null
billingrequiredobject
sourcerequiredobject
duesrequiredlist of object
paymentsrequiredlist of object
autopayrequiredobject or null
autopayAvailablerequiredboolean
noterequiredstring or null
createdAtrequiredstring
paidAtrequiredstring or null
get/v1/orders/{id}One order

Answer

FieldType
idrequiredstring (uuid)
numberrequiredinteger
statusrequiredone of: "pending", "active", "paid", "cancelled", "refunded"
userrequiredobject
productIdrequiredstring (uuid) or null
productTitlerequiredstring
planNamerequiredstring
planKindrequiredone of: "one_time", "instalments", "subscription"
subtotalPaiserequiredinteger
discountPaiserequiredinteger
walletPaiserequiredinteger
totalPaiserequiredinteger
paidPaiserequiredinteger
balancePaiserequiredinteger
couponCoderequiredstring or null
affiliaterequiredstring or null
billingrequiredobject
sourcerequiredobject
duesrequiredlist of object
paymentsrequiredlist of object
autopayrequiredobject or null
autopayAvailablerequiredboolean
noterequiredstring or null
createdAtrequiredstring
paidAtrequiredstring or null
get/v1/duesInstalments still to be paid

Query

overdueone of: "0", "1"
qstring
pageinteger

Answer

FieldType
itemsrequiredlist of object
totalrequiredinteger
totalPaiserequiredinteger
post/v1/payments/offlineRecord a payment made outside the app

Body

FieldType
dueIdsrequiredlist of string (uuid)
methodrequiredone of: "cash", "upi", "bank_transfer", "cheque", "card", "other"
referencestring or null
paidOnstring (date)
notestring or null

Answer

FieldType
paymentIdrequiredstring (uuid)
post/v1/payments/{id}/refundRefund a payment

Record a refund made at the gateway or by hand; optionally end the learner's access.

Body

FieldType
amountPaiseinteger
reasonstring or null
endAccessboolean

Answer

FieldType
ordersrequiredlist of object
get/v1/invoicesInvoices

Query

fromstring (date)
tostring (date)
pageinteger

Answer

FieldType
itemsrequiredlist of object
totalrequiredinteger
get/v1/leadsEnquiries

Query

statusone of: "new", "contacted", "converted", "lost"
qstring
pageinteger

Answer

FieldType
itemsrequiredlist of object
totalrequiredinteger
post/v1/leadsAdd an enquiry

From your own website form or ads. Sent on to the CRM webhook and the lead.created event.

Body

FieldType
namerequiredstring
phonerequiredstring
emailstring (email) or null
productIdstring (uuid) or null
messagestring or null
sourceobject
websitestring

Answer

FieldType
okrequiredtrue
post/v1/leads/importBring in enquiries from a spreadsheet or another CRM

Up to 5,000 at a time; anyone already in Enquiries (same phone or email) is skipped. Nobody is messaged. Set dryRun to check the rows first.

Body

FieldType
rowsrequiredlist of object
dryRunboolean

Answer

FieldType
createdrequiredinteger
skippedrequiredinteger
errorsrequiredlist of object
notesrequiredlist of object
dryRunrequiredboolean
patch/v1/leads/{id}Update an enquiry

Body

FieldType
statusone of: "new", "contacted", "converted", "lost"
notestring or null

Answer

FieldType
idrequiredstring (uuid)
namerequiredstring
phonerequiredstring or null
emailrequiredstring or null
productTitlerequiredstring or null
messagerequiredstring or null
sourcerequiredobject
statusrequiredone of: "new", "contacted", "converted", "lost"
noterequiredstring or null
createdAtrequiredstring

Messages

get/v1/announcementsAnnouncements sent

Answer

FieldType
itemsrequiredlist of object
post/v1/announcementsSend an announcement

To learners, parents or tutors (all, or some courses), in the app and by push, WhatsApp, SMS or email.

Body

FieldType
titlerequiredstring
bodyrequiredstring
audiencerequiredobject
channelsrequiredlist of one of: "app", "push", "whatsapp", "sms", "email"

Answer

FieldType
titlerequiredstring
bodyrequiredstring
audiencerequiredobject
channelsrequiredlist of one of: "app", "push", "whatsapp", "sms", "email"
idrequiredstring (uuid)
sentByrequiredstring or null
recipientsrequiredinteger or null
createdAtrequiredstring

Forms

get/v1/formsList forms

Answer

FieldType
itemsrequiredlist of object
get/v1/forms/{id}One form with its questions

Answer

FieldType
idrequiredstring (uuid)
titlerequiredstring
slugrequiredstring
statusrequiredone of: "draft", "open", "closed"
responsesrequiredinteger
lastResponseAtrequiredstring or null
createdAtrequiredstring
descriptionrequiredstring
fieldsrequiredlist of object
settingsrequiredobject
urlrequiredstring
updatedAtrequiredstring
get/v1/forms/{id}/responsesA form's responses

Newest first; search by name, phone, email or any answer. Up to 1000 a page.

Query

qstring
pageinteger
limitinteger

Answer

FieldType
itemsrequiredlist of object
totalrequiredinteger
get/v1/forms/{id}/responses/{responseId}One response

Answer

FieldType
idrequiredstring (uuid)
createdAtrequiredstring
namerequiredstring or null
emailrequiredstring or null
phonerequiredstring or null
personrequiredobject or null
leadIdrequiredstring (uuid) or null
answersrequiredlist of object

Agreements

get/v1/agreementsList agreements

Answer

FieldType
itemsrequiredlist of object
post/v1/agreements/{id}/sendAsk people to sign

Particular learners or parents, or everyone in a course (or their parents). Nobody is asked twice.

Body

FieldType
userIdslist of string (uuid)
courseIdstring (uuid) or null
toone of: "learners", "parents", "both"

Answer

FieldType
sentrequiredinteger
skippedrequiredinteger
get/v1/agreements/{id}/requestsWho was asked, and who signed

Answer

FieldType
itemsrequiredlist of object
get/v1/agreement-requests/{id}/signedA signed copy

The exact text signed, the typed and drawn signature, when, and from where.

Answer

FieldType
idrequiredstring (uuid)
instituteNamerequiredstring
titlerequiredstring
bodyrequiredstring
signerrequiredobject
learnerNamerequiredstring or null
signedNamerequiredstring
signaturerequiredstring or null
signedAtrequiredstring
iprequiredstring or null
userAgentrequiredstring or null
bodyHashrequiredstring

Analytics

get/v1/analytics/overviewHow the institute did over a period

Query

fromstring (date)
tostring (date)

Answer

FieldType
fromrequiredstring (date)
torequiredstring (date)
previousFromrequiredstring (date)
previousTorequiredstring (date)
learnersrequiredobject
classesrequiredobject
learningrequiredobject
moneyrequiredobject or null
bucketrequiredone of: "day", "week", "month"
trendrequiredlist of object
storagerequiredobject or null
get/v1/analytics/coursesEach course over a period

Query

fromstring (date)
tostring (date)

Answer

FieldType
fromrequiredstring (date)
torequiredstring (date)
itemsrequiredlist of object
get/v1/analytics/courses/{id}One batch: attendance, progress and fees per learner

Query

fromstring (date)
tostring (date)

Answer

FieldType
fromrequiredstring (date)
torequiredstring (date)
courserequiredobject
summaryrequiredobject
sessionsrequiredlist of object
learnersrequiredlist of object
get/v1/analytics/learnersLearners and who needs attention

Query

fromstring (date)
tostring (date)
courseIdstring (uuid)
riskone of: "1", "attendance", "inactive", "fees", "scores"
qstring
sortone of: "name", "attendance", "lastActive", "score"
pageinteger
allone of: "1"

Answer

FieldType
fromrequiredstring (date)
torequiredstring (date)
itemsrequiredlist of object
totalrequiredinteger
riskCountsrequiredobject
pageSizerequiredinteger

Webhooks

get/v1/webhook-eventsEvery event a webhook can receive

Answer

FieldType
itemsrequiredlist of object
post/v1/webhooksSubscribe an address to events

Empty events means every event. The secret in the reply signs every delivery; it is only shown here. Zapier and n8n triggers subscribe this way and unsubscribe with DELETE.

Body

FieldType
urlrequiredstring (uri)
descriptionstring
eventslist of one of: "member.created", "member.updated", "enrollment.created", "enrollment.ended", "course.created", "course.updated", "class.scheduled", "class.updated", "class.cancelled", "class.started", "class.ended", "attendance.marked", "recording.added", "test.submitted", "test.graded", "certificate.issued", "order.created", "payment.paid", "payment.refunded", "lead.created", "progress_report.published", "announcement.sent", "form.submitted", "agreement.signed"

Answer

FieldType
endpointrequiredobject
secretrequiredstring
get/v1/webhooksList webhooks (signed-in staff)

Answer

FieldType
itemsrequiredlist of object
patch/v1/webhooks/{id}Change a webhook (signed-in staff)

Body

FieldType
urlstring (uri)
descriptionstring
eventslist of one of: "member.created", "member.updated", "enrollment.created", "enrollment.ended", "course.created", "course.updated", "class.scheduled", "class.updated", "class.cancelled", "class.started", "class.ended", "attendance.marked", "recording.added", "test.submitted", "test.graded", "certificate.issued", "order.created", "payment.paid", "payment.refunded", "lead.created", "progress_report.published", "announcement.sent", "form.submitted", "agreement.signed"
enabledboolean

Answer

FieldType
idrequiredstring (uuid)
urlrequiredstring
descriptionrequiredstring
eventsrequiredlist of one of: "member.created", "member.updated", "enrollment.created", "enrollment.ended", "course.created", "course.updated", "class.scheduled", "class.updated", "class.cancelled", "class.started", "class.ended", "attendance.marked", "recording.added", "test.submitted", "test.graded", "certificate.issued", "order.created", "payment.paid", "payment.refunded", "lead.created", "progress_report.published", "announcement.sent", "form.submitted", "agreement.signed"
enabledrequiredboolean
disabledReasonrequiredstring or null
failingSincerequiredstring or null
lastSuccessAtrequiredstring or null
createdAtrequiredstring
delete/v1/webhooks/{id}Unsubscribe

Answers 204 with no body.

post/v1/webhooks/{id}/rotateNew signing secret (signed-in staff)

Answer

FieldType
secretrequiredstring
get/v1/webhooks/{id}/deliveriesWhat was sent, and what came back (signed-in staff)

Query

statusone of: "pending", "delivered", "failed"
beforestring (uuid)

Answer

FieldType
itemsrequiredlist of object
hasMorerequiredboolean
post/v1/webhooks/{id}/testSend a test event (signed-in staff)

Answer

FieldType
idrequiredstring (uuid)
eventIdrequiredstring (uuid)
eventrequiredstring
statusrequiredone of: "pending", "delivered", "failed"
attemptsrequiredinteger
nextAttemptAtrequiredstring or null
responseStatusrequiredinteger or null
responseBodyrequiredstring or null
errorrequiredstring or null
durationMsrequiredinteger or null
createdAtrequiredstring
deliveredAtrequiredstring or null
payloadrequiredobject