Webhooks
Webhooks are automations that send information to your outside applications when certain events happen in Populi.
Setting up webhooks
Account Administrators can create webhooks in Populi under Account → Webhooks. Each webhook listens for one event, and when that event occurs Populi sends an HTTP request (GET or POST, configurable per webhook) to the URL you provide.
In production, URLs entered with http:// are automatically upgraded to https:// before the request is sent. Webhooks do not fire from sandbox instances unless they are explicitly enabled in the instance settings.
If your server returns a non-2xx response, Populi retries the delivery up to four times at increasingly distant intervals. After five consecutive failures, the webhook action is paused so you can fix the issue before it resumes.
The webhook payload
Every webhook request contains a JSON body with the following envelope, followed by a data object whose contents depend on the specific event.
{
"id": "a1b2c3d4e5f6...",
"event": "person_created",
"created_at": "2026-09-17T12:00:00+00:00",
"sandbox": false,
"api_version": "2026-07-13",
"data": { ... }
}
The sandbox field is true when the request comes from a validation or demo instance, and false for live production data. The payload may also include a legacy test_mode field that mirrors sandbox; it is deprecated and will be removed in the future.
Verifying webhook authenticity
Each webhook request includes two headers you can use to verify it came from Populi:
Populi-RSA-SHA256-Signature— a hex-encoded RSA-SHA256 signature of the raw JSON request bodyPopuli-RSA-Public-Key-Fingerprint— the fingerprint of the public key used to verify the signature
Verifying the signature is optional, but recommended if your webhook endpoint is publicly accessible.
Available events
The following events can trigger webhooks. The value shown in the Event column is the exact string that appears in the event field of the payload. Example default payloads for each event appear below under a heading named for the trigger. You can also request a live expanded payload at any time with GET /api2/webhooks/examples/:trigger_abbrv (see show example webhook payload).
| Event | Name |
|---|---|
term_updated |
Academic Term Updated |
ach_payment_failed |
ACH Online Payment Failed |
advisor_assigned_to_student |
Advisor Assigned to Student |
financial_aid_award_accepted |
Aid Award Accepted |
financial_aid_award_created |
Aid Award Added |
financial_aid_award_declined |
Aid Award Declined |
application_created |
Application Added |
application_fee_paid |
Application Fee Paid |
application_field_status_updated |
Application Field Status Changed (new) |
application_linked_to_person |
Application Linked to Person |
application_representative_assigned |
Application Representative Assigned |
application_status_updated |
Application Status Updated |
assignment_grade_updated |
Assignment Grade Changed |
attendance_updated |
Attendance Changed |
bulletin_board_comment_created |
Bulletin Board Comment Added |
bulletin_board_post_created |
Bulletin Board Post Added |
campus_added_to_student |
Campus Added to Student |
campus_removed_from_student |
Campus Removed from Student |
bookstore_order_processed |
Campus Store Order Processed |
consequence_created |
Consequence Added |
course_offering_created |
Course Added |
course_offering_deleted |
Course Deleted |
course_discussion_created |
Course Discussion Added |
course_discussion_reply_created |
Course Discussion Comment Added |
course_discussion_reported |
Course Discussion Report |
course_offering_catalog_course_updated |
Course Offering Catalog Course Updated |
course_offering_updated |
Course Updated |
credit_created |
Credit Posted |
custom_field_added_to_person |
Custom Field Added to Person |
custom_field_removed_from_person |
Custom Field Removed from Person |
donation_created |
Donation Added |
download_ready |
Download Ready |
enrollment_agreement_signed |
Enrollment Agreement Signed |
enrollment_updated |
Enrollment Updated |
transaction_voided |
Financial Transaction Voided |
form_response_field_note_added |
Form Response Field Note Added |
form_response_request_resent |
Form Response Reminder Sent |
form_response_requested |
Form Response Requested |
form_response_respondent_updated |
Form Response Respondent Updated |
form_response_status_updated |
Form Response Status Updated |
form_response_submitted |
Form Response Submitted |
group_bulletin_board_comment_created |
Group Bulletin Board Comment Added |
group_bulletin_board_post_created |
Group Bulletin Board Post Added |
group_discussion_created |
Group Discussion Added |
group_discussion_reply_created |
Group Discussion Comment Added |
group_discussion_reported |
Group Discussion Report |
group_invitation_requested |
Group Invitation Requested |
inquiry_created |
Inquiry Added |
inquiry_linked_to_person |
Inquiry Linked to Person |
inquiry_representative_assigned |
Inquiry Representative Assigned |
integration_log_error |
Integration Log Error |
invoice_paid |
Invoice Paid |
invoice_created |
Invoice Posted |
isir_imported |
ISIR Imported |
lead_created |
Lead Added |
lead_representative_assigned |
Lead Representative Assigned |
lead_status_updated |
Lead Status Updated |
library_resource_lost |
Library Resource Lost |
transfer_credit_awaiting_approval |
New Transfer Credits Awaiting Approval |
online_reference_submitted |
Online Reference Submitted |
contact_organization_created |
Organization Added |
contact_organization_deleted |
Organization Deleted |
contact_organization_updated |
Organization Updated |
password_changed |
Password Changed |
payment_created |
Payment Received |
person_created |
Person Added |
person_custom_field_data_changed |
Person Custom Field Data Changed |
person_deleted |
Person Deleted |
person_updated |
Person Updated |
recurring_payment_status_change |
Recurring Payment Status Change |
refund_created |
Refund Posted |
role_added_reactivated |
Role Added/Reactivated |
role_removed_inactivated |
Role Removed/Inactivated |
social_feed_followed |
Social Feed Followed |
standardized_test_score_updated |
Standardized Test Score Updated |
course_offering_student_status_updated |
Student Course Enrollment Status Changed |
student_degree_added |
Student Degree Added |
student_degree_removed |
Student Degree Removed |
student_degree_updated |
Student Degree Updated |
student_program_added |
Student Program Added |
student_program_removed |
Student Program Removed |
student_program_updated |
Student Program Updated |
tag_added_to_contact_organization |
Tag Added to Organization |
tag_added_to_person |
Tag Added to Person |
tag_removed_from_contact_organization |
Tag Removed from Organization |
tag_removed_from_person |
Tag Removed from Person |
assignment_test_submitted |
Test Submitted |
to_do_assigned |
To-do Assigned |
to_do_completed |
To-do Completed |
transcript_request_created |
Transcript Request Created |
transfer_credit_approved |
Transfer Credit Approved |
ungraded_test_questions |
Ungraded Test Questions |
user_created |
User Account Added |
user_deleted |
User Account Deleted |
user_blocked |
User Blocked |
login |
User Login |
violation_created |
Violation Added |
Example default payloads for each event appear below, each under a heading named for the trigger. These examples show the default payload a webhook receives unless the webhook action is configured to expand related data. To request a live expanded payload for any event, call GET /api2/webhooks/examples/:trigger_abbrv with {"expand": "all"} in the JSON body (see show example webhook payload).
Academic Term Updated
Whenever an academic term is updated.
{
"id": "0d42b589b770b3aaa2bccb02d270da76",
"event": "term_updated",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"online_payment": {
"object": "online_payment",
"id": 6,
"status": "construction",
"type": "card",
"link_type": null,
"link_id": null,
"person_id": null,
"contact_organization_id": null,
"sponsor_id": null,
"sponsor_type": null,
"amount": 0,
"net_amount": null,
"preset_amount": null,
"first_name": "Testy",
"last_name": "McTest",
"street": "123 Test Street",
"city": "Example City",
"state": "XY",
"postal": "00000",
"country": "US",
"email": "test@example.com",
"phone": "555-0100",
"layout": "web",
"card_status": null,
"card_last_digits": "1111",
"card_bin": null,
"card_is_international": false,
"card_funding": null,
"card_country": null,
"card_brand": null,
"card_expiration_month": 2,
"card_expiration_year": 2010,
"card_transaction_id": "A050B0F28A084EF1B9E445D2792A85B6",
"card_approval_code": "17360",
"card_processing_fee": null,
"card_status_code": "APPROVED",
"card_status_msg": "APPROVED",
"bank_name": null,
"bank_account_last_four": null,
"last_settlement_check_at": null,
"ach_status": null,
"ach_return_id": null,
"ach_settled_response": null,
"ach_return_message": null,
"ach_transaction_id": null,
"paypal_order_id": null,
"paypal_payer_id": null,
"paypal_authorization_id": null,
"paypal_status": null,
"reference_number": null,
"organization_name": null,
"payment_token": null,
"payment_gateway_id": null,
"payment_gateway_processing_fee": null,
"payment_gateway_transaction_id": null,
"payment_gateway_trace_id": null,
"gateway_customer_token": null,
"gateway_source_token": null,
"payment_frequency": null,
"recurring_interval": null,
"recurring_day": null,
"recurring_until": null,
"recurring_max_times": null,
"recurring_money_transfer_id": null,
"comment": null,
"donate_page_id": null,
"donation_campaign_id": null,
"donation_appeal_id": null,
"draft_date_id": null,
"back_url": null,
"payment_secret": null,
"disable_service_fee": false,
"cover_processing_fees": false,
"added_at": null,
"added_by_id": null
},
"sandbox": true
}
}
ACH Online Payment Failed
Whenever an ACH/eCheck payment fails/bounces
{
"id": "5726bed24be54502a150eb252d27201f",
"event": "ach_payment_failed",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"transcript_request": {
"object": "transcript_request",
"id": 1,
"status": "active",
"person_id": 8,
"student_firstname": null,
"student_lastname": null,
"student_ssn": null,
"student_birthdate": null,
"student_last_enrolled_year": null,
"program_id": 1,
"delivery_method_id": 3,
"recipient_name": "Example University",
"email": null,
"street": "123 Test Street",
"city": "Example City",
"state": "XY",
"postal": "00000",
"country": "US",
"notes": "blah",
"fee_id": 1,
"fee_amount": 22,
"charge_method": "card",
"online_payment_id": 1,
"sales_receipt_id": 1,
"pending_charge_id": null,
"requester_name": "Testy McTest",
"requester_electronic_signature": "Testy T",
"requester_email": "test@example.com",
"requester_phone": "555-0100",
"secret": "72b5c7ee3d15f15932ea3a1813251b29",
"completed_at": "2022-07-13T18:32:47+00:00",
"completed_by_id": 10,
"refunded_at": null,
"refunded_by_id": null,
"added_at": "2022-07-13T18:31:48+00:00",
"added_by_id": 10
},
"sandbox": true
}
}
Advisor Assigned to Student
Whenever an advisor is assigned to a student.
{
"id": "9ff20b3e7a7c47ae745c42ae5c70096f",
"event": "advisor_assigned_to_student",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"advisor": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"student_advisor": {
"object": "student_advisor",
"id": 2,
"student_id": 11,
"advisor_id": 16,
"type": "primary",
"added_at": "2026-09-29T23:27:54+00:00",
"added_by_id": 13
},
"sandbox": true
}
}
Aid Award Accepted
Whenever an aid award is accepted by the student.
{
"id": "2c95f6f1a6430ee359907b041accfbb1",
"event": "financial_aid_award_accepted",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"aid_award": {
"object": "aid_award",
"id": 6,
"student_id": 1,
"aid_year_id": 1,
"aid_type_id": 1,
"sequence_number": 1,
"original_accepted_amount": 1000,
"award_limit": 1000,
"max_amount": 1000,
"net_amount": 1000,
"multiplier": null,
"auto_calc_percent_amount": false,
"fee_percent": null,
"status": "accepted",
"loan_booked_on": null,
"loan_payment_to_servicer_amount": 0,
"loan_payment_to_servicer_date": null,
"plus_loan_has_endorser": false,
"plus_loan_endorser_amount": null,
"plus_loan_credit_requirements_met": false,
"loan_booked_cod_response_id": null,
"year_coa": null,
"cod_id": null,
"cod_amount": 0,
"cod_origination_fee_percent": null,
"cod_start_date": null,
"cod_end_date": null,
"cod_student_level_code": null,
"cod_academic_year_start_date": null,
"cod_academic_year_end_date": null,
"cod_program_length": null,
"cod_program_length_units": null,
"cod_program_credential_level": null,
"enrollment_status_effective_date": null,
"cod_special_program": null,
"cod_weeks_programs_academic_year": null,
"cod_program_cip_code": null,
"cod_plus_application_id": null,
"cod_borrower_id": null,
"refunds_go_to": "student",
"cod_most_recent_response_id": null,
"cod_status": null,
"cod_sync_logic": "automatic",
"cod_syncable": true,
"cod_syncable_errors": null,
"cod_needs_sync": true,
"cod_originated": false,
"external_id": null,
"esign_by_student_at": null,
"esign_by_student_ip": null,
"work_study_hours_per_week": null,
"added_at": "2015-09-08T07:53:22+00:00",
"added_by_id": 11
},
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Aid Award Added
Whenever an aid award is added to a student.
{
"id": "e823655c0760b4bf900d65b21986781c",
"event": "financial_aid_award_created",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"isir": {
"object": "isir",
"id": 6,
"batch_id": 1,
"cps_transaction_number": 1,
"cps_processed_date": "2011-03-20",
"status": "pending",
"content": "2200100405ED01EDIT QUESTION BORN BEFORE ASSUME NO EDIT 1004 VA2078419880102 1 1 VA 2 1 2 3 100000{000000000000{00000{000000000000000000 1222222211111 1 391091111FATHERLASTNAME A19540101000000000 VA 03 121 00500{0000000300500{00999I000000000000000000 011 001002 20110101B I1A20110320 TG53275 200100405 1A20110320 001 Y20110320 Y Y 4 2 0000000000 5200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000{0008550000000{00000000008550000855}000427N 000000{000000{0008550000000{00000000008550000855}000427N00000000{000000000000000000 000000{000000{ 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 000000000000010000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 1 8 8 F 4 149001146124219220221222115116118053117006000000000000000000 10 N 011 N04 N04 NY NY N05 NM YY N\/A 002405N\/A N\/A N\/A N\/A N\/A 777777008888999999 005309 NNNNNNNNNNNNNNYYY NNNNNN01Y 00280000003732 20090315 ",
"comment_codes": null,
"aid_year_id": 2,
"aid_application_id": null,
"imported_by_id": null,
"imported_at": null
},
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Aid Award Declined
Whenever an aid award is declined by the student.
{
"id": "7a97f5b6835bff8caf6e6bf419393a78",
"event": "financial_aid_award_declined",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"aid_award": {
"object": "aid_award",
"id": 6,
"student_id": 1,
"aid_year_id": 1,
"aid_type_id": 1,
"sequence_number": 1,
"original_accepted_amount": 1000,
"award_limit": 1000,
"max_amount": 1000,
"net_amount": 1000,
"multiplier": null,
"auto_calc_percent_amount": false,
"fee_percent": null,
"status": "accepted",
"loan_booked_on": null,
"loan_payment_to_servicer_amount": 0,
"loan_payment_to_servicer_date": null,
"plus_loan_has_endorser": false,
"plus_loan_endorser_amount": null,
"plus_loan_credit_requirements_met": false,
"loan_booked_cod_response_id": null,
"year_coa": null,
"cod_id": null,
"cod_amount": 0,
"cod_origination_fee_percent": null,
"cod_start_date": null,
"cod_end_date": null,
"cod_student_level_code": null,
"cod_academic_year_start_date": null,
"cod_academic_year_end_date": null,
"cod_program_length": null,
"cod_program_length_units": null,
"cod_program_credential_level": null,
"enrollment_status_effective_date": null,
"cod_special_program": null,
"cod_weeks_programs_academic_year": null,
"cod_program_cip_code": null,
"cod_plus_application_id": null,
"cod_borrower_id": null,
"refunds_go_to": "student",
"cod_most_recent_response_id": null,
"cod_status": null,
"cod_sync_logic": "automatic",
"cod_syncable": true,
"cod_syncable_errors": null,
"cod_needs_sync": true,
"cod_originated": false,
"external_id": null,
"esign_by_student_at": null,
"esign_by_student_ip": null,
"work_study_hours_per_week": null,
"added_at": "2015-09-08T07:53:22+00:00",
"added_by_id": 11
},
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Application Added
Whenever an application is added.
{
"id": "69ac62d31ce584124130c8df548ae17b",
"event": "application_created",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"application": {
"object": "application",
"id": 1,
"cloned_from_id": null,
"person_id": null,
"lead_id": null,
"first_name": "Homestar",
"middle_name": null,
"last_name": "Runner",
"email": "homestar@populi.co",
"phone": null,
"address_id": null,
"application_template_id": 3,
"form_version_id": 2,
"counselor_id": null,
"program_id": 1,
"degree_seeking": true,
"degree_id": null,
"specialization_id": null,
"academic_term_id": 1,
"campus_id": null,
"lead_source_id": null,
"started_on": "2013-03-19",
"submitted_at": null,
"pending_decision_on": null,
"decision_on": null,
"confirmed_on": null,
"withdrawn_on": null,
"expected_enrollment": "full_time",
"status": "in_progress",
"provisional": false,
"provisional_note": null,
"hs_grad_date": null,
"fee_status": "unpaid",
"fee_id": null,
"fee_amount": null,
"fee_discount": null,
"fee_payment": "before_start",
"sales_receipt_id": null,
"letter_printed_at": null,
"letter_printed_by_id": null,
"prospect_activity_at": null,
"staff_activity_at": null,
"percent_complete": 0,
"active_questions": null,
"localization_id": null,
"added_at": "2013-03-19T21:20:18+00:00",
"added_by_id": null,
"applicant_url": "https:\/\/yourschool.populiweb.com\/router\/admissions\/onlineapplications\/show\/g64c8ee3f6da7a2293a0f77a7a697b178cc281eaf34e1c8ac6c5b784920d90c6944c03ac9ff54c31fc4b06ac3952ebc36969975080cc106f69f060ccb76abb9"
},
"application_template": {
"object": "application_template",
"id": 3,
"current_version_id": 2,
"name": "Test v3",
"type": "application",
"published": true,
"custom_css": null,
"show_online": true,
"require_address": false,
"fee_id": null,
"fee_amount": 75,
"fee_payment": "before_start",
"allow_undecided": true,
"enable_sms_verification": true,
"redirect_url": null,
"thank_you_message": null,
"initial_email_template_id": null,
"enable_initial_email": true,
"retired_by_id": null,
"retired_at": null,
"default_localization_id": null,
"added_at": null,
"added_by_id": null
},
"sandbox": true
}
}
Application Fee Paid
Whenever an application's fee is paid.
{
"id": "7ceccb4da96ddbd5e38834b59997a6b7",
"event": "application_fee_paid",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"course_offering_catalog_course": {
"object": "catalog_course",
"id": 30,
"course_offering_id": 23144,
"catalog_course_id": 576,
"primary": true,
"abbrv": "BS502",
"name": "Pentateuch",
"description": null,
"section": "1",
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"affects_standing": true,
"affects_full_time_status": true,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"fulfills_program_requirements": true,
"minimum_attendance": null,
"hide_self_register": false,
"self_enroll": "yes",
"self_audit": true,
"added_at": null,
"added_by_id": null
},
"course": {
"object": "course_offering",
"id": 21908,
"academic_term_id": 4,
"campus_id": null,
"finalized": false,
"finalized_at": null,
"max_enrolled": null,
"max_auditors": null,
"roster_visibility": true,
"start_date": "2022-05-20",
"end_date": "2022-10-08",
"add_drop_time": null,
"published": true,
"open_to_students_date": null,
"closed_to_students_date": null,
"faculty_can_manage_roster": false,
"faculty_can_override_enrollment": false,
"students_can_add_discussions": true,
"disable_student_bulletin_board_posts": false,
"allow_auditor_assignments": false,
"allow_auditor_attendance": false,
"allow_auditor_evaluations": false,
"waiting_list_management": "automatic",
"image_file_id": null,
"show_progress_to_students": false,
"catalog_courses": [
{
"object": "catalog_course",
"id": 1,
"course_offering_id": 21908,
"catalog_course_id": 688,
"primary": true,
"abbrv": "LAT101",
"name": "Beginning Latin I",
"description": null,
"section": "1",
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"affects_standing": true,
"affects_full_time_status": true,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"fulfills_program_requirements": true,
"minimum_attendance": null,
"hide_self_register": false,
"self_enroll": "yes",
"self_audit": true,
"delivery_methods": [
{
"object": "course_delivery_method",
"id": 5,
"name": "Hybrid Online",
"distance_education": false,
"status": "active",
"primary": 1,
"added_at": null,
"added_by_id": null
}
],
"added_at": null,
"added_by_id": null
}
]
},
"sandbox": true
}
}
Application Field Status Changed (new)
Whenever the status changes on an application field (e.g. from In Progress to Submitted).
{
"id": "cfe90b794c78b4f1f77f6c21a8a81129",
"event": "application_field_status_updated",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"application": {
"object": "application",
"id": 1,
"cloned_from_id": null,
"person_id": null,
"lead_id": null,
"first_name": "Homestar",
"middle_name": null,
"last_name": "Runner",
"email": "homestar@populi.co",
"phone": null,
"address_id": null,
"application_template_id": 3,
"form_version_id": 2,
"counselor_id": null,
"program_id": 1,
"degree_seeking": true,
"degree_id": null,
"specialization_id": null,
"academic_term_id": 1,
"campus_id": null,
"lead_source_id": null,
"started_on": "2013-03-19",
"submitted_at": null,
"pending_decision_on": null,
"decision_on": null,
"confirmed_on": null,
"withdrawn_on": null,
"expected_enrollment": "full_time",
"status": "in_progress",
"provisional": false,
"provisional_note": null,
"hs_grad_date": null,
"fee_status": "unpaid",
"fee_id": null,
"fee_amount": null,
"fee_discount": null,
"fee_payment": "before_start",
"sales_receipt_id": null,
"letter_printed_at": null,
"letter_printed_by_id": null,
"prospect_activity_at": null,
"staff_activity_at": null,
"percent_complete": 0,
"active_questions": null,
"localization_id": null,
"added_at": "2013-03-19T21:20:18+00:00",
"added_by_id": null,
"applicant_url": "https:\/\/yourschool.populiweb.com\/router\/admissions\/onlineapplications\/show\/g64c8ee3f6da7a2293a0f77a7a697b178cc281eaf34e1c8ac6c5b784920d90c6944c03ac9ff54c31fc4b06ac3952ebc36969975080cc106f69f060ccb76abb9"
},
"form_field": {
"object": "form_field",
"id": 1,
"reporting_id": 1,
"name": "Short Answer",
"description": null,
"input_type": "short_answer",
"model_type": null,
"model_id": null,
"min": null,
"max": null,
"added_at": null,
"added_by_id": null
},
"form_response_field_status": {
"object": "form_response_field_status",
"id": 1,
"owner_type": "form_response",
"owner_id": 1,
"form_field_id": 1,
"status": "accepted",
"submitted_at": null,
"submitted_by_id": null,
"decision_at": "2021-10-22T12:59:05+00:00",
"decision_by_id": 1257
},
"application_template": {
"object": "application_template",
"id": 3,
"current_version_id": 2,
"name": "Test v3",
"type": "application",
"published": true,
"custom_css": null,
"show_online": true,
"require_address": false,
"fee_id": null,
"fee_amount": 75,
"fee_payment": "before_start",
"allow_undecided": true,
"enable_sms_verification": true,
"redirect_url": null,
"thank_you_message": null,
"initial_email_template_id": null,
"enable_initial_email": true,
"retired_by_id": null,
"retired_at": null,
"default_localization_id": null,
"added_at": null,
"added_by_id": null
},
"sandbox": true
}
}
Application Linked to Person
Whenever an application is linked to a person.
{
"id": "0e1ef8d013f57f18c8518494fdae8d23",
"event": "application_linked_to_person",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"application": {
"object": "application",
"id": 1,
"cloned_from_id": null,
"person_id": null,
"lead_id": null,
"first_name": "Homestar",
"middle_name": null,
"last_name": "Runner",
"email": "homestar@populi.co",
"phone": null,
"address_id": null,
"application_template_id": 3,
"form_version_id": 2,
"counselor_id": null,
"program_id": 1,
"degree_seeking": true,
"degree_id": null,
"specialization_id": null,
"academic_term_id": 1,
"campus_id": null,
"lead_source_id": null,
"started_on": "2013-03-19",
"submitted_at": null,
"pending_decision_on": null,
"decision_on": null,
"confirmed_on": null,
"withdrawn_on": null,
"expected_enrollment": "full_time",
"status": "in_progress",
"provisional": false,
"provisional_note": null,
"hs_grad_date": null,
"fee_status": "unpaid",
"fee_id": null,
"fee_amount": null,
"fee_discount": null,
"fee_payment": "before_start",
"sales_receipt_id": null,
"letter_printed_at": null,
"letter_printed_by_id": null,
"prospect_activity_at": null,
"staff_activity_at": null,
"percent_complete": 0,
"active_questions": null,
"localization_id": null,
"added_at": "2013-03-19T21:20:18+00:00",
"added_by_id": null,
"applicant_url": "https:\/\/yourschool.populiweb.com\/router\/admissions\/onlineapplications\/show\/g64c8ee3f6da7a2293a0f77a7a697b178cc281eaf34e1c8ac6c5b784920d90c6944c03ac9ff54c31fc4b06ac3952ebc36969975080cc106f69f060ccb76abb9"
},
"lead": {
"object": "lead",
"id": 1,
"person_id": 1,
"status": "prospect",
"program_id": null,
"degree_id": null,
"specialization_id": null,
"academic_term_id": null,
"active": true,
"inactive_on": "2013-10-02",
"lead_source_id": null,
"ceeb_code": null,
"source_comment": null,
"education_level_id": 0,
"declined_reason_id": null,
"declined_reason_comment": null,
"counselor_id": 1011,
"highschool_graduation_date": null,
"most_recent": false,
"added_on": "2013-10-02",
"import_id": null,
"added_at": "2013-10-02T20:37:53+00:00",
"added_by_id": 185755,
"updated_at": "2013-10-02T14:35:29+00:00",
"updated_by_id": 1999
},
"application_template": {
"object": "application_template",
"id": 3,
"current_version_id": 2,
"name": "Test v3",
"type": "application",
"published": true,
"custom_css": null,
"show_online": true,
"require_address": false,
"fee_id": null,
"fee_amount": 75,
"fee_payment": "before_start",
"allow_undecided": true,
"enable_sms_verification": true,
"redirect_url": null,
"thank_you_message": null,
"initial_email_template_id": null,
"enable_initial_email": true,
"retired_by_id": null,
"retired_at": null,
"default_localization_id": null,
"added_at": null,
"added_by_id": null
},
"sandbox": true
}
}
Application Representative Assigned
Whenever an Application is assigned to a representative.
{
"id": "f2a1ad0caaa23a0801ad2fb3f31a7ba9",
"event": "application_representative_assigned",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"application": {
"object": "application",
"id": 1,
"cloned_from_id": null,
"person_id": null,
"lead_id": null,
"first_name": "Homestar",
"middle_name": null,
"last_name": "Runner",
"email": "homestar@populi.co",
"phone": null,
"address_id": null,
"application_template_id": 3,
"form_version_id": 2,
"counselor_id": null,
"program_id": 1,
"degree_seeking": true,
"degree_id": null,
"specialization_id": null,
"academic_term_id": 1,
"campus_id": null,
"lead_source_id": null,
"started_on": "2013-03-19",
"submitted_at": null,
"pending_decision_on": null,
"decision_on": null,
"confirmed_on": null,
"withdrawn_on": null,
"expected_enrollment": "full_time",
"status": "in_progress",
"provisional": false,
"provisional_note": null,
"hs_grad_date": null,
"fee_status": "unpaid",
"fee_id": null,
"fee_amount": null,
"fee_discount": null,
"fee_payment": "before_start",
"sales_receipt_id": null,
"letter_printed_at": null,
"letter_printed_by_id": null,
"prospect_activity_at": null,
"staff_activity_at": null,
"percent_complete": 0,
"active_questions": null,
"localization_id": null,
"added_at": "2013-03-19T21:20:18+00:00",
"added_by_id": null,
"applicant_url": "https:\/\/yourschool.populiweb.com\/router\/admissions\/onlineapplications\/show\/g64c8ee3f6da7a2293a0f77a7a697b178cc281eaf34e1c8ac6c5b784920d90c6944c03ac9ff54c31fc4b06ac3952ebc36969975080cc106f69f060ccb76abb9"
},
"representative": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Application Status Updated
Whenever an application's status is updated.
{
"id": "f748fe32cef6a62693035e9815bca116",
"event": "application_status_updated",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"application": {
"object": "application",
"id": 1,
"cloned_from_id": null,
"person_id": null,
"lead_id": null,
"first_name": "Homestar",
"middle_name": null,
"last_name": "Runner",
"email": "homestar@populi.co",
"phone": null,
"address_id": null,
"application_template_id": 3,
"form_version_id": 2,
"counselor_id": null,
"program_id": 1,
"degree_seeking": true,
"degree_id": null,
"specialization_id": null,
"academic_term_id": 1,
"campus_id": null,
"lead_source_id": null,
"started_on": "2013-03-19",
"submitted_at": null,
"pending_decision_on": null,
"decision_on": null,
"confirmed_on": null,
"withdrawn_on": null,
"expected_enrollment": "full_time",
"status": "in_progress",
"provisional": false,
"provisional_note": null,
"hs_grad_date": null,
"fee_status": "unpaid",
"fee_id": null,
"fee_amount": null,
"fee_discount": null,
"fee_payment": "before_start",
"sales_receipt_id": null,
"letter_printed_at": null,
"letter_printed_by_id": null,
"prospect_activity_at": null,
"staff_activity_at": null,
"percent_complete": 0,
"active_questions": null,
"localization_id": null,
"added_at": "2013-03-19T21:20:18+00:00",
"added_by_id": null,
"applicant_url": "https:\/\/yourschool.populiweb.com\/router\/admissions\/onlineapplications\/show\/g64c8ee3f6da7a2293a0f77a7a697b178cc281eaf34e1c8ac6c5b784920d90c6944c03ac9ff54c31fc4b06ac3952ebc36969975080cc106f69f060ccb76abb9"
},
"lead": {
"object": "lead",
"id": 1,
"person_id": 1,
"status": "prospect",
"program_id": null,
"degree_id": null,
"specialization_id": null,
"academic_term_id": null,
"active": true,
"inactive_on": "2013-10-02",
"lead_source_id": null,
"ceeb_code": null,
"source_comment": null,
"education_level_id": 0,
"declined_reason_id": null,
"declined_reason_comment": null,
"counselor_id": 1011,
"highschool_graduation_date": null,
"most_recent": false,
"added_on": "2013-10-02",
"import_id": null,
"added_at": "2013-10-02T20:37:53+00:00",
"added_by_id": 185755,
"updated_at": "2013-10-02T14:35:29+00:00",
"updated_by_id": 1999
},
"application_template": {
"object": "application_template",
"id": 3,
"current_version_id": 2,
"name": "Test v3",
"type": "application",
"published": true,
"custom_css": null,
"show_online": true,
"require_address": false,
"fee_id": null,
"fee_amount": 75,
"fee_payment": "before_start",
"allow_undecided": true,
"enable_sms_verification": true,
"redirect_url": null,
"thank_you_message": null,
"initial_email_template_id": null,
"enable_initial_email": true,
"retired_by_id": null,
"retired_at": null,
"default_localization_id": null,
"added_at": null,
"added_by_id": null
},
"sandbox": true
}
}
Assignment Grade Changed
Whenever a student's assignment grade changes (or is set for the first time).
{
"id": "7e6fc6ba5e1160789d6954dc1cf29513",
"event": "assignment_grade_updated",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"course": {
"object": "course_offering",
"id": 21908,
"academic_term_id": 4,
"campus_id": null,
"finalized": false,
"finalized_at": null,
"max_enrolled": null,
"max_auditors": null,
"roster_visibility": true,
"start_date": "2022-05-20",
"end_date": "2022-10-08",
"add_drop_time": null,
"published": true,
"open_to_students_date": null,
"closed_to_students_date": null,
"faculty_can_manage_roster": false,
"faculty_can_override_enrollment": false,
"students_can_add_discussions": true,
"disable_student_bulletin_board_posts": false,
"allow_auditor_assignments": false,
"allow_auditor_attendance": false,
"allow_auditor_evaluations": false,
"waiting_list_management": "automatic",
"image_file_id": null,
"show_progress_to_students": false,
"catalog_courses": [
{
"object": "catalog_course",
"id": 1,
"course_offering_id": 21908,
"catalog_course_id": 688,
"primary": true,
"abbrv": "LAT101",
"name": "Beginning Latin I",
"description": null,
"section": "1",
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"affects_standing": true,
"affects_full_time_status": true,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"fulfills_program_requirements": true,
"minimum_attendance": null,
"hide_self_register": false,
"self_enroll": "yes",
"self_audit": true,
"delivery_methods": [
{
"object": "course_delivery_method",
"id": 5,
"name": "Hybrid Online",
"distance_education": false,
"status": "active",
"primary": 1,
"added_at": null,
"added_by_id": null
}
],
"added_at": null,
"added_by_id": null
}
]
},
"assignment": {
"object": "assignment",
"id": 29656,
"course_offering_id": 21908,
"name": "Midterm Test",
"points": 100,
"due_at": null,
"available_from": null,
"available_until": null,
"published": true,
"description": "This is a test",
"assignment_group_id": null,
"lesson_id": null,
"type": "test",
"allowed_file_types": null,
"visible_to_students_before_available": true,
"extra_credit": false,
"pass_fail": false,
"mandatory_pass": false,
"peer_review": false,
"anonymous_reviews": true,
"submission_visibility": "always",
"randomize_submissions": false,
"review_visibility": "never",
"allow_review_comments": false,
"peer_grade": false,
"grade_submissions": null,
"grade_reviews": null,
"reviews_due_at": null,
"reviews_closed_at": null,
"auto_check_submissions_for_plagiarism": false,
"plagiarism_checks_visible_to_students": false,
"plagiarism_check_provider": null,
"release_grades": "yes",
"release_grades_at": null,
"added_at": null,
"added_by_id": null
},
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"assignment_grade": {
"object": "assignment_grade",
"id": 216741,
"course_offering_id": 22776,
"assignment_id": 21998,
"student_id": 1,
"grade": 93,
"excused": false,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"updated_by_id": null
},
"enrollment": {
"object": "enrollment",
"id": 6000000,
"course_offering_id": 21908,
"catalog_course_id": 688,
"student_id": 16,
"status": "enrolled",
"status_expires_at": null,
"pending_reason": null,
"final_comment": null,
"final_grade": 91.5,
"final_attendance": 0,
"released_final_grade": null,
"commented_by_id": null,
"enrolled_by_id": null,
"enrolled_by_type": "registrar",
"status_date": "2022-10-05",
"enrolled_date": null,
"credits": 2,
"hours": 2,
"attendance_hours": null,
"clinical_hours": null,
"pass_fail": false,
"finalized": false,
"finalized_at": null,
"delivery_method_id": null,
"automatically_removed_at": null,
"automatically_removed_from": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"display_status": "Enrolled"
},
"sandbox": true
}
}
Attendance Changed
Whenever a student's attendance changes in a particular course meeting (or is set for the first time).
{
"id": "13906f805a3ae224b3d1a481437efe70",
"event": "attendance_updated",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"course": {
"object": "course_offering",
"id": 21908,
"academic_term_id": 4,
"campus_id": null,
"finalized": false,
"finalized_at": null,
"max_enrolled": null,
"max_auditors": null,
"roster_visibility": true,
"start_date": "2022-05-20",
"end_date": "2022-10-08",
"add_drop_time": null,
"published": true,
"open_to_students_date": null,
"closed_to_students_date": null,
"faculty_can_manage_roster": false,
"faculty_can_override_enrollment": false,
"students_can_add_discussions": true,
"disable_student_bulletin_board_posts": false,
"allow_auditor_assignments": false,
"allow_auditor_attendance": false,
"allow_auditor_evaluations": false,
"waiting_list_management": "automatic",
"image_file_id": null,
"show_progress_to_students": false,
"catalog_courses": [
{
"object": "catalog_course",
"id": 1,
"course_offering_id": 21908,
"catalog_course_id": 688,
"primary": true,
"abbrv": "LAT101",
"name": "Beginning Latin I",
"description": null,
"section": "1",
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"affects_standing": true,
"affects_full_time_status": true,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"fulfills_program_requirements": true,
"minimum_attendance": null,
"hide_self_register": false,
"self_enroll": "yes",
"self_audit": true,
"delivery_methods": [
{
"object": "course_delivery_method",
"id": 5,
"name": "Hybrid Online",
"distance_education": false,
"status": "active",
"primary": 1,
"added_at": null,
"added_by_id": null
}
],
"added_at": null,
"added_by_id": null
}
]
},
"attendance": {
"object": "course_attendance",
"id": 5,
"student_id": 12,
"course_meeting_id": 2,
"status": "present",
"present_coef": 1,
"note": null,
"kiosk_id": null,
"beacon_id": null,
"device_id": null,
"beacon_found_at": null,
"attendance_hours": null,
"clinical_hours": null,
"added_at": null,
"added_by_id": null
},
"enrollment": {
"object": "enrollment",
"id": 6000000,
"course_offering_id": 21908,
"catalog_course_id": 688,
"student_id": 16,
"status": "enrolled",
"status_expires_at": null,
"pending_reason": null,
"final_comment": null,
"final_grade": 91.5,
"final_attendance": 0,
"released_final_grade": null,
"commented_by_id": null,
"enrolled_by_id": null,
"enrolled_by_type": "registrar",
"status_date": "2022-10-05",
"enrolled_date": null,
"credits": 2,
"hours": 2,
"attendance_hours": null,
"clinical_hours": null,
"pass_fail": false,
"finalized": false,
"finalized_at": null,
"delivery_method_id": null,
"automatically_removed_at": null,
"automatically_removed_from": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"display_status": "Enrolled"
},
"sandbox": true
}
}
Bulletin Board Comment Added
Whenever someone comments on an existing post in a course bulletin board.
{
"id": "2738a73427b95852fa3672973c1bbecf",
"event": "bulletin_board_comment_created",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"course": {
"object": "course_offering",
"id": 21908,
"academic_term_id": 4,
"campus_id": null,
"finalized": false,
"finalized_at": null,
"max_enrolled": null,
"max_auditors": null,
"roster_visibility": true,
"start_date": "2022-05-20",
"end_date": "2022-10-08",
"add_drop_time": null,
"published": true,
"open_to_students_date": null,
"closed_to_students_date": null,
"faculty_can_manage_roster": false,
"faculty_can_override_enrollment": false,
"students_can_add_discussions": true,
"disable_student_bulletin_board_posts": false,
"allow_auditor_assignments": false,
"allow_auditor_attendance": false,
"allow_auditor_evaluations": false,
"waiting_list_management": "automatic",
"image_file_id": null,
"show_progress_to_students": false,
"catalog_courses": [
{
"object": "catalog_course",
"id": 1,
"course_offering_id": 21908,
"catalog_course_id": 688,
"primary": true,
"abbrv": "LAT101",
"name": "Beginning Latin I",
"description": null,
"section": "1",
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"affects_standing": true,
"affects_full_time_status": true,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"fulfills_program_requirements": true,
"minimum_attendance": null,
"hide_self_register": false,
"self_enroll": "yes",
"self_audit": true,
"delivery_methods": [
{
"object": "course_delivery_method",
"id": 5,
"name": "Hybrid Online",
"distance_education": false,
"status": "active",
"primary": 1,
"added_at": null,
"added_by_id": null
}
],
"added_at": null,
"added_by_id": null
}
]
},
"post": {
"object": "post",
"id": 6,
"content": "Career fair this Saturday!",
"owner_type": "person",
"owner_id": null,
"added_by_instructor": false,
"edited_at": null,
"edited_post_id": null,
"file_id": null,
"added_at": "2020-04-15T18:36:01+00:00",
"added_by_id": 1
},
"comment": {
"object": "post_comment",
"id": 6,
"parent_comment_id": null,
"post_id": 7,
"content": "I like how you state the thesis clearly.",
"edited_at": null,
"edited_comment_id": null,
"added_at": "2020-04-14T15:33:42+00:00",
"added_by_id": 1257
},
"author": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Bulletin Board Post Added
Whenever someone posts to a course bulletin board.
{
"id": "7f70951a97032bea51be236f622df1d3",
"event": "bulletin_board_post_created",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"course": {
"object": "course_offering",
"id": 21908,
"academic_term_id": 4,
"campus_id": null,
"finalized": false,
"finalized_at": null,
"max_enrolled": null,
"max_auditors": null,
"roster_visibility": true,
"start_date": "2022-05-20",
"end_date": "2022-10-08",
"add_drop_time": null,
"published": true,
"open_to_students_date": null,
"closed_to_students_date": null,
"faculty_can_manage_roster": false,
"faculty_can_override_enrollment": false,
"students_can_add_discussions": true,
"disable_student_bulletin_board_posts": false,
"allow_auditor_assignments": false,
"allow_auditor_attendance": false,
"allow_auditor_evaluations": false,
"waiting_list_management": "automatic",
"image_file_id": null,
"show_progress_to_students": false,
"catalog_courses": [
{
"object": "catalog_course",
"id": 1,
"course_offering_id": 21908,
"catalog_course_id": 688,
"primary": true,
"abbrv": "LAT101",
"name": "Beginning Latin I",
"description": null,
"section": "1",
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"affects_standing": true,
"affects_full_time_status": true,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"fulfills_program_requirements": true,
"minimum_attendance": null,
"hide_self_register": false,
"self_enroll": "yes",
"self_audit": true,
"delivery_methods": [
{
"object": "course_delivery_method",
"id": 5,
"name": "Hybrid Online",
"distance_education": false,
"status": "active",
"primary": 1,
"added_at": null,
"added_by_id": null
}
],
"added_at": null,
"added_by_id": null
}
]
},
"post": {
"object": "post",
"id": 6,
"content": "Career fair this Saturday!",
"owner_type": "person",
"owner_id": null,
"added_by_instructor": false,
"edited_at": null,
"edited_post_id": null,
"file_id": null,
"added_at": "2020-04-15T18:36:01+00:00",
"added_by_id": 1
},
"author": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Campus Added to Student
Whenever a campus is added to a student.
{
"id": "86cb2765639b9bac3884b1fe880d14be",
"event": "campus_added_to_student",
"created_at": "2026-09-29T23:27:57+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"campus": {
"object": "campus",
"id": 8,
"name": "Main Campus",
"city": "Moscow",
"state": "ID",
"postal": "83843",
"country": "US",
"status": "active",
"primary": true,
"timezone": "America\/Los_Angeles",
"cod_routing_id": null,
"ope_id": null,
"export_prefix": null,
"ipeds_unit_id": null,
"country_full": "United States",
"added_at": null,
"added_by_id": null
},
"sandbox": true
}
}
Campus Removed from Student
Whenever a campus is removed from a student.
{
"id": "14cfc5e08bc39f9ae789986a0b373376",
"event": "campus_removed_from_student",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"campus": {
"object": "campus",
"id": 8,
"name": "Main Campus",
"city": "Moscow",
"state": "ID",
"postal": "83843",
"country": "US",
"status": "active",
"primary": true,
"timezone": "America\/Los_Angeles",
"cod_routing_id": null,
"ope_id": null,
"export_prefix": null,
"ipeds_unit_id": null,
"country_full": "United States",
"added_at": null,
"added_by_id": null
},
"sandbox": true
}
}
Campus Store Order Processed
Whenever a new campus store order is made
Example payload currently unavailable for this event.
Consequence Added
Whenever a campus life consequence is added.
{
"id": "d589bce3ebeab8c97e0b139a8b7448fe",
"event": "consequence_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"consequence": {
"object": "student_consequence",
"id": 1,
"student_id": 8,
"consequence_id": 1,
"description": "Warning Letter to Parents",
"status": "pending",
"pending_charge_id": null,
"added_on": "2022-07-19",
"added_at": "2022-07-19T16:20:01+00:00",
"added_by_id": 10
},
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Course Added
Whenever a course offering is added to a term.
{
"id": "738fdb36008d3772edfe2190c2e10e7f",
"event": "course_offering_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"course": {
"object": "course_offering",
"id": 21908,
"academic_term_id": 4,
"campus_id": null,
"finalized": false,
"finalized_at": null,
"max_enrolled": null,
"max_auditors": null,
"roster_visibility": true,
"start_date": "2022-05-20",
"end_date": "2022-10-08",
"add_drop_time": null,
"published": true,
"open_to_students_date": null,
"closed_to_students_date": null,
"faculty_can_manage_roster": false,
"faculty_can_override_enrollment": false,
"students_can_add_discussions": true,
"disable_student_bulletin_board_posts": false,
"allow_auditor_assignments": false,
"allow_auditor_attendance": false,
"allow_auditor_evaluations": false,
"waiting_list_management": "automatic",
"image_file_id": null,
"show_progress_to_students": false,
"catalog_courses": [
{
"object": "catalog_course",
"id": 1,
"course_offering_id": 21908,
"catalog_course_id": 688,
"primary": true,
"abbrv": "LAT101",
"name": "Beginning Latin I",
"description": null,
"section": "1",
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"affects_standing": true,
"affects_full_time_status": true,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"fulfills_program_requirements": true,
"minimum_attendance": null,
"hide_self_register": false,
"self_enroll": "yes",
"self_audit": true,
"delivery_methods": [
{
"object": "course_delivery_method",
"id": 5,
"name": "Hybrid Online",
"distance_education": false,
"status": "active",
"primary": 1,
"added_at": null,
"added_by_id": null
}
],
"added_at": null,
"added_by_id": null
}
]
},
"sandbox": true
}
}
Course Deleted
Whenever a course offering is deleted.
{
"id": "cc2b7dfc4e43242bab35190f8596bd66",
"event": "course_offering_deleted",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"course": {
"object": "course_offering",
"id": 21908,
"academic_term_id": 4,
"campus_id": null,
"finalized": false,
"finalized_at": null,
"max_enrolled": null,
"max_auditors": null,
"roster_visibility": true,
"start_date": "2022-05-20",
"end_date": "2022-10-08",
"add_drop_time": null,
"published": true,
"open_to_students_date": null,
"closed_to_students_date": null,
"faculty_can_manage_roster": false,
"faculty_can_override_enrollment": false,
"students_can_add_discussions": true,
"disable_student_bulletin_board_posts": false,
"allow_auditor_assignments": false,
"allow_auditor_attendance": false,
"allow_auditor_evaluations": false,
"waiting_list_management": "automatic",
"image_file_id": null,
"show_progress_to_students": false,
"catalog_courses": [
{
"object": "catalog_course",
"id": 1,
"course_offering_id": 21908,
"catalog_course_id": 688,
"primary": true,
"abbrv": "LAT101",
"name": "Beginning Latin I",
"description": null,
"section": "1",
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"affects_standing": true,
"affects_full_time_status": true,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"fulfills_program_requirements": true,
"minimum_attendance": null,
"hide_self_register": false,
"self_enroll": "yes",
"self_audit": true,
"delivery_methods": [
{
"object": "course_delivery_method",
"id": 5,
"name": "Hybrid Online",
"distance_education": false,
"status": "active",
"primary": 1,
"added_at": null,
"added_by_id": null
}
],
"added_at": null,
"added_by_id": null
}
]
},
"sandbox": true
}
}
Course Discussion Added
Whenever someone adds a discussion in a course.
{
"id": "c71d4ed855097c52b70cedd738b1b02f",
"event": "course_discussion_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"lead": {
"object": "lead",
"id": 1,
"person_id": 1,
"status": "prospect",
"program_id": null,
"degree_id": null,
"specialization_id": null,
"academic_term_id": null,
"active": true,
"inactive_on": "2013-10-02",
"lead_source_id": null,
"ceeb_code": null,
"source_comment": null,
"education_level_id": 0,
"declined_reason_id": null,
"declined_reason_comment": null,
"counselor_id": 1011,
"highschool_graduation_date": null,
"most_recent": false,
"added_on": "2013-10-02",
"import_id": null,
"added_at": "2013-10-02T20:37:53+00:00",
"added_by_id": 185755,
"updated_at": "2013-10-02T14:35:29+00:00",
"updated_by_id": 1999
},
"representative": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Course Discussion Comment Added
Whenever someone comments on an existing post in a course discussion.
{
"id": "8d3840c8885c987cffd384ecdffbbc69",
"event": "course_discussion_reply_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"form": {
"object": "form",
"id": 1,
"current_version_id": 1,
"type": "form",
"name": "Form",
"description": null,
"image_file_id": null,
"published": true,
"accept_responses": true,
"available_from": null,
"available_until": null,
"self_service": false,
"require_user": false,
"require_request": false,
"anonymous_responses": false,
"can_choose_linked_model": false,
"user_response_limit": null,
"total_response_limit": null,
"response_review": "review",
"enable_sms_verification": false,
"redirect_url": null,
"thank_you_message": null,
"custom_css": null,
"fee_id": null,
"fee_amount": null,
"can_charge_to_account": false,
"default_localization_id": null,
"retired_by_id": null,
"retired_at": null,
"added_at": null,
"added_by_id": null
},
"response": {
"object": "form_response",
"id": 1,
"form_id": 1,
"form_version_id": 1,
"form_response_batch_id": null,
"person_id": 10,
"first_name": null,
"last_name": null,
"email": null,
"review": "review",
"status": "submitted",
"needs_review": null,
"needs_resubmit": null,
"fee_id": null,
"fee_amount": null,
"fee_discount": null,
"can_charge_to_account": false,
"fee_status": "unpaid",
"charge_method": null,
"sales_receipt_id": null,
"started_at": "2022-07-13T23:07:51+00:00",
"submitted_at": "2022-07-13T23:08:31+00:00",
"decision_by_id": null,
"decision_at": null,
"localization_id": null,
"requested_by_id": null,
"requested_at": null,
"added_at": "2022-07-13T23:07:51+00:00",
"respondent_url": "https:\/\/yourschool.populiweb.com\/router\/forms\/respond\/g795538da7a2293a0f77a7a697b178cc281eaf34e1c8ac6c5b784920d90c6944c03ac9ff54c31fc4b06ac3952ebc36969975080cc106f69f060ccb76abb9"
},
"sandbox": true
}
}
Course Discussion Report
Whenever a course discussion or comment is reported as inappropriate.
{
"id": "3566e6c05044a343dae5e9cefdd6aed5",
"event": "course_discussion_reported",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"meal_plan": {
"object": "meal_plan",
"id": 1,
"name": "Gold",
"amount": 1500,
"status": "active",
"external_account_id": 1,
"account_id": 1,
"added_at": null,
"added_by_id": null
},
"meal_plan_student": {
"object": "meal_plan_student",
"id": 6,
"term_id": 73,
"student_id": 61,
"plan_id": 1,
"amount": 1500,
"adjustment": 0,
"added_at": null,
"added_by_id": null
},
"sandbox": true
}
}
Course Offering Catalog Course Updated
Whenever an course offering catalog course is updated.
Example payload currently unavailable for this event.
Course Updated
Whenever a course offering is updated.
{
"id": "3dc5c6cb3b561006cc59dc2c18a5f1e6",
"event": "course_offering_updated",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"course": {
"object": "course_offering",
"id": 21908,
"academic_term_id": 4,
"campus_id": null,
"finalized": false,
"finalized_at": null,
"max_enrolled": null,
"max_auditors": null,
"roster_visibility": true,
"start_date": "2022-05-20",
"end_date": "2022-10-08",
"add_drop_time": null,
"published": true,
"open_to_students_date": null,
"closed_to_students_date": null,
"faculty_can_manage_roster": false,
"faculty_can_override_enrollment": false,
"students_can_add_discussions": true,
"disable_student_bulletin_board_posts": false,
"allow_auditor_assignments": false,
"allow_auditor_attendance": false,
"allow_auditor_evaluations": false,
"waiting_list_management": "automatic",
"image_file_id": null,
"show_progress_to_students": false,
"catalog_courses": [
{
"object": "catalog_course",
"id": 1,
"course_offering_id": 21908,
"catalog_course_id": 688,
"primary": true,
"abbrv": "LAT101",
"name": "Beginning Latin I",
"description": null,
"section": "1",
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"affects_standing": true,
"affects_full_time_status": true,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"fulfills_program_requirements": true,
"minimum_attendance": null,
"hide_self_register": false,
"self_enroll": "yes",
"self_audit": true,
"delivery_methods": [
{
"object": "course_delivery_method",
"id": 5,
"name": "Hybrid Online",
"distance_education": false,
"status": "active",
"primary": 1,
"added_at": null,
"added_by_id": null
}
],
"added_at": null,
"added_by_id": null
}
]
},
"affected_data": [
{
"object": "course_offering_updated_affected_data",
"id": 16,
"model_type_id": 6,
"type": "COURSE_FINALIZED"
}
],
"course_meeting_cancellation": {
"object": "course_meeting_cancellation",
"id": 1,
"course_offering_id": 1,
"start": "2017-06-07T15:00:00+00:00",
"end": "2017-06-07T16:00:00+00:00",
"is_deletion": false,
"added_at": "2017-06-21T07:05:14+00:00",
"added_by_id": 3158221
},
"sandbox": true
}
}
Credit Posted
Whenever a credit is posted to someone's account.
{
"id": "7683af379e7d70989415382d42d66164",
"event": "credit_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"credit": {
"object": "credit",
"id": 8,
"actor_type": "person",
"actor_id": 1,
"number": 2,
"description": null,
"transaction_id": 10,
"amount": 1234.56,
"due_on": "2009-04-07",
"status": null,
"posted_on": "2015-03-10",
"academic_term_id": null,
"items": []
},
"sandbox": true
}
}
Custom Field Added to Person
Whenever a custom field is added to a person.
{
"id": "22a69309068b8dd172a343a9ce8bafc6",
"event": "custom_field_added_to_person",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"custom_field": {
"object": "custom_info_field",
"id": 18,
"name": "Business membership number",
"input_type": "text_area",
"type": "organization",
"description": null,
"value_permissions": "default"
},
"academic_term": {
"object": "academic_term",
"id": 8,
"academic_year_id": 4,
"name": "Spring 2010",
"display_name": "Spring 2010 2009-2010",
"start_date": "2010-02-01",
"end_date": "2010-05-15",
"grades_date": "2010-05-10",
"add_drop_time": "2010-02-15T00:00:00+00:00",
"enrollment_start_time": "2010-01-01T00:00:00+00:00",
"enrollment_end_time": null,
"max_enrolled_credits": null,
"max_enrolled_hours": null,
"max_audit_credits": null,
"max_audit_hours": null,
"can_overlap_dates": false,
"level": "single",
"academic_term_type_id": null,
"is_for_transcript": true,
"is_for_billing": true,
"is_for_campus_life": true,
"is_entrance_term": true,
"evaluations_available_from": null,
"evaluations_available_to": null,
"evaluations_lock_grades_at": null,
"online_registration_delay_until": null,
"online_registration_randomization_seconds": 0,
"evaluations_lock_grades_until": null,
"evaluations_available_to_faculty": null,
"lms_sync": null,
"external_id": null,
"start_year": 2009,
"end_year": 2010,
"added_at": null,
"added_by_id": null,
"type": "standard"
},
"custom_field_data": {
"object": "custom_info_data",
"id": 1,
"custom_info_field_id": 11,
"academic_term_id": null,
"value": "Silver Ford Escape",
"owner_id": 1,
"import_id": null,
"custom_info_field": {
"object": "custom_info_field",
"id": 11,
"name": "Car Model",
"input_type": "text_area",
"type": "person",
"description": null,
"value_permissions": "default"
},
"added_at": "2022-01-01T00:05:30+00:00",
"added_by_id": 2,
"updated_at": "2022-01-01T00:05:30+00:00",
"updated_by_id": 2,
"option_value": null
},
"sandbox": true
}
}
Custom Field Removed from Person
Whenever a custom field is removed from a person.
{
"id": "119d85d1573605508d47ec4881811fbd",
"event": "custom_field_removed_from_person",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"custom_field": {
"object": "custom_info_field",
"id": 18,
"name": "Business membership number",
"input_type": "text_area",
"type": "organization",
"description": null,
"value_permissions": "default"
},
"academic_term": {
"object": "academic_term",
"id": 8,
"academic_year_id": 4,
"name": "Spring 2010",
"display_name": "Spring 2010 2009-2010",
"start_date": "2010-02-01",
"end_date": "2010-05-15",
"grades_date": "2010-05-10",
"add_drop_time": "2010-02-15T00:00:00+00:00",
"enrollment_start_time": "2010-01-01T00:00:00+00:00",
"enrollment_end_time": null,
"max_enrolled_credits": null,
"max_enrolled_hours": null,
"max_audit_credits": null,
"max_audit_hours": null,
"can_overlap_dates": false,
"level": "single",
"academic_term_type_id": null,
"is_for_transcript": true,
"is_for_billing": true,
"is_for_campus_life": true,
"is_entrance_term": true,
"evaluations_available_from": null,
"evaluations_available_to": null,
"evaluations_lock_grades_at": null,
"online_registration_delay_until": null,
"online_registration_randomization_seconds": 0,
"evaluations_lock_grades_until": null,
"evaluations_available_to_faculty": null,
"lms_sync": null,
"external_id": null,
"start_year": 2009,
"end_year": 2010,
"added_at": null,
"added_by_id": null,
"type": "standard"
},
"custom_field_data": {
"object": "custom_info_data",
"id": 1,
"custom_info_field_id": 11,
"academic_term_id": null,
"value": "Silver Ford Escape",
"owner_id": 1,
"import_id": null,
"custom_info_field": {
"object": "custom_info_field",
"id": 11,
"name": "Car Model",
"input_type": "text_area",
"type": "person",
"description": null,
"value_permissions": "default"
},
"added_at": "2022-01-01T00:05:30+00:00",
"added_by_id": 2,
"updated_at": "2022-01-01T00:05:30+00:00",
"updated_by_id": 2,
"option_value": null
},
"sandbox": true
}
}
Donation Added
Whenever a new donation is added.
{
"id": "f7825d932c37a537bee159df64d27b01",
"event": "donation_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"donation": {
"object": "donation",
"id": 6,
"transaction_id": 200,
"number": 43,
"canadian_donation_receipt_id": null,
"payment_method": "card",
"payment_reference": null,
"online": true,
"online_payment_id": null,
"recurring": false,
"donor_id": null,
"first_name": "Testy",
"last_name": "McTest",
"initial_organization_name": null,
"phone_number": "555-0100",
"email_address": "test@example.com",
"donor_comment": null,
"staff_comment": null,
"gift_in_kind_description": null,
"acknowledged_at": null,
"acknowledged_by_id": null,
"secret": "16b97ef909e2f05dd1f16a3c2b0b8b6a",
"amount": 100,
"currency": "USD",
"exchange_rate": null,
"home_currency_amount": 100,
"donate_page_id": null,
"campaign_id": null,
"appeal_id": null,
"recurring_money_transfer_id": null,
"refunded_by_transaction_id": null
},
"sandbox": true
}
}
Download Ready
Whenever an export file is ready for download.
{
"id": "66a86a17a2f1af08e45747e42322703e",
"event": "download_ready",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"meal_plan": {
"object": "meal_plan",
"id": 1,
"name": "Gold",
"amount": 1500,
"status": "active",
"external_account_id": 1,
"account_id": 1,
"added_at": null,
"added_by_id": null
},
"meal_plan_student": {
"object": "meal_plan_student",
"id": 6,
"term_id": 73,
"student_id": 61,
"plan_id": 1,
"amount": 1500,
"adjustment": 0,
"added_at": null,
"added_by_id": null
},
"sandbox": true
}
}
Enrollment Agreement Signed
Whenever a student's enrollment agreement is signed.
{
"id": "c488a13e7d06b33f88f2a9d5c5e874be",
"event": "enrollment_agreement_signed",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"enrollment_agreement": {
"object": "enrollment_agreement",
"id": 1,
"student_id": 1,
"academic_term_id": 1,
"print_layout_id": 6,
"signed": null,
"file_id": null,
"source": "uploaded_manually",
"amount": 1456.5,
"user_ip": null,
"status": "signed",
"status_at": "2020-05-06T23:45:33+00:00",
"notify_student": true,
"added_at": "2020-05-06T23:45:33+00:00",
"added_by_id": 1
},
"sandbox": true
}
}
Enrollment Updated
Whenever a student's enrollment in a course changes.
{
"id": "1c731db27d163d6dec76769a8bcee562",
"event": "enrollment_updated",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"course": {
"object": "course_offering",
"id": 21908,
"academic_term_id": 4,
"campus_id": null,
"finalized": false,
"finalized_at": null,
"max_enrolled": null,
"max_auditors": null,
"roster_visibility": true,
"start_date": "2022-05-20",
"end_date": "2022-10-08",
"add_drop_time": null,
"published": true,
"open_to_students_date": null,
"closed_to_students_date": null,
"faculty_can_manage_roster": false,
"faculty_can_override_enrollment": false,
"students_can_add_discussions": true,
"disable_student_bulletin_board_posts": false,
"allow_auditor_assignments": false,
"allow_auditor_attendance": false,
"allow_auditor_evaluations": false,
"waiting_list_management": "automatic",
"image_file_id": null,
"show_progress_to_students": false,
"catalog_courses": [
{
"object": "catalog_course",
"id": 1,
"course_offering_id": 21908,
"catalog_course_id": 688,
"primary": true,
"abbrv": "LAT101",
"name": "Beginning Latin I",
"description": null,
"section": "1",
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"affects_standing": true,
"affects_full_time_status": true,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"fulfills_program_requirements": true,
"minimum_attendance": null,
"hide_self_register": false,
"self_enroll": "yes",
"self_audit": true,
"delivery_methods": [
{
"object": "course_delivery_method",
"id": 5,
"name": "Hybrid Online",
"distance_education": false,
"status": "active",
"primary": 1,
"added_at": null,
"added_by_id": null
}
],
"added_at": null,
"added_by_id": null
}
]
},
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"enrollment": {
"object": "enrollment",
"id": 6000000,
"course_offering_id": 21908,
"catalog_course_id": 688,
"student_id": 16,
"status": "enrolled",
"status_expires_at": null,
"pending_reason": null,
"final_comment": null,
"final_grade": 91.5,
"final_attendance": 0,
"released_final_grade": null,
"commented_by_id": null,
"enrolled_by_id": null,
"enrolled_by_type": "registrar",
"status_date": "2022-10-05",
"enrolled_date": null,
"credits": 2,
"hours": 2,
"attendance_hours": null,
"clinical_hours": null,
"pass_fail": false,
"finalized": false,
"finalized_at": null,
"delivery_method_id": null,
"automatically_removed_at": null,
"automatically_removed_from": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"display_status": "Enrolled"
},
"affected_data": {
"object": "enrollment_updated_affected_data",
"id": 18,
"model_type_id": 117,
"type": "ATTENDANCE_PERCENT"
},
"sandbox": true
}
}
Financial Transaction Voided
Whenever a financial transaction is voided.
{
"id": "818b03084d86061c6c912de716514c7b",
"event": "transaction_voided",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"transaction": {
"object": "financial_transaction",
"id": 9,
"type": "sales_invoice",
"status": "posted",
"number": 1234,
"posted_on": "2015-03-10",
"actor_type": "person",
"actor_id": 1,
"voided_at": null,
"voided_by_id": null,
"link_type": null,
"link_id": null,
"amount": 1234.56,
"reverses": null,
"reversed_by_id": null,
"reposts": null,
"reposted_by_id": null,
"repostable": true,
"added_at": "2015-03-10T19:33:11+00:00",
"added_by_id": null
},
"sandbox": true
}
}
Form Response Field Note Added
Whenever a note that is visible to the respondent is added to a form field.
{
"id": "32829c7579bb667a3a38a3aafe3a9960",
"event": "form_response_field_note_added",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"form": {
"object": "form",
"id": 1,
"current_version_id": 1,
"type": "form",
"name": "Form",
"description": null,
"image_file_id": null,
"published": true,
"accept_responses": true,
"available_from": null,
"available_until": null,
"self_service": false,
"require_user": false,
"require_request": false,
"anonymous_responses": false,
"can_choose_linked_model": false,
"user_response_limit": null,
"total_response_limit": null,
"response_review": "review",
"enable_sms_verification": false,
"redirect_url": null,
"thank_you_message": null,
"custom_css": null,
"fee_id": null,
"fee_amount": null,
"can_charge_to_account": false,
"default_localization_id": null,
"retired_by_id": null,
"retired_at": null,
"added_at": null,
"added_by_id": null
},
"response": {
"object": "form_response",
"id": 1,
"form_id": 1,
"form_version_id": 1,
"form_response_batch_id": null,
"person_id": 10,
"first_name": null,
"last_name": null,
"email": null,
"review": "review",
"status": "submitted",
"needs_review": null,
"needs_resubmit": null,
"fee_id": null,
"fee_amount": null,
"fee_discount": null,
"can_charge_to_account": false,
"fee_status": "unpaid",
"charge_method": null,
"sales_receipt_id": null,
"started_at": "2022-07-13T23:07:51+00:00",
"submitted_at": "2022-07-13T23:08:31+00:00",
"decision_by_id": null,
"decision_at": null,
"localization_id": null,
"requested_by_id": null,
"requested_at": null,
"added_at": "2022-07-13T23:07:51+00:00",
"respondent_url": "https:\/\/yourschool.populiweb.com\/router\/forms\/respond\/g795538da7a2293a0f77a7a697b178cc281eaf34e1c8ac6c5b784920d90c6944c03ac9ff54c31fc4b06ac3952ebc36969975080cc106f69f060ccb76abb9"
},
"field": {
"object": "form_field",
"id": 1,
"reporting_id": 1,
"name": "Short Answer",
"description": null,
"input_type": "short_answer",
"model_type": null,
"model_id": null,
"min": null,
"max": null,
"added_at": null,
"added_by_id": null
},
"note": {
"object": "form_response_note",
"id": 1,
"owner_type": "application",
"owner_id": 3,
"section_id": null,
"content": "Test application note",
"file_id": null,
"added_at": "2013-03-19T23:46:43+00:00",
"added_by_id": 2
},
"sandbox": true
}
}
Form Response Reminder Sent
Whenever a form response reminder is sent.
{
"id": "f482618817846b24519091903bf758bd",
"event": "form_response_request_resent",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"form": {
"object": "form",
"id": 1,
"current_version_id": 1,
"type": "form",
"name": "Form",
"description": null,
"image_file_id": null,
"published": true,
"accept_responses": true,
"available_from": null,
"available_until": null,
"self_service": false,
"require_user": false,
"require_request": false,
"anonymous_responses": false,
"can_choose_linked_model": false,
"user_response_limit": null,
"total_response_limit": null,
"response_review": "review",
"enable_sms_verification": false,
"redirect_url": null,
"thank_you_message": null,
"custom_css": null,
"fee_id": null,
"fee_amount": null,
"can_charge_to_account": false,
"default_localization_id": null,
"retired_by_id": null,
"retired_at": null,
"added_at": null,
"added_by_id": null
},
"response": {
"object": "form_response",
"id": 1,
"form_id": 1,
"form_version_id": 1,
"form_response_batch_id": null,
"person_id": 10,
"first_name": null,
"last_name": null,
"email": null,
"review": "review",
"status": "submitted",
"needs_review": null,
"needs_resubmit": null,
"fee_id": null,
"fee_amount": null,
"fee_discount": null,
"can_charge_to_account": false,
"fee_status": "unpaid",
"charge_method": null,
"sales_receipt_id": null,
"started_at": "2022-07-13T23:07:51+00:00",
"submitted_at": "2022-07-13T23:08:31+00:00",
"decision_by_id": null,
"decision_at": null,
"localization_id": null,
"requested_by_id": null,
"requested_at": null,
"added_at": "2022-07-13T23:07:51+00:00",
"respondent_url": "https:\/\/yourschool.populiweb.com\/router\/forms\/respond\/g795538da7a2293a0f77a7a697b178cc281eaf34e1c8ac6c5b784920d90c6944c03ac9ff54c31fc4b06ac3952ebc36969975080cc106f69f060ccb76abb9"
},
"sandbox": true
}
}
Form Response Requested
Whenever a form response is requested.
{
"id": "db71838b6ef86b8b224af8f835a6b33c",
"event": "form_response_requested",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"form": {
"object": "form",
"id": 1,
"current_version_id": 1,
"type": "form",
"name": "Form",
"description": null,
"image_file_id": null,
"published": true,
"accept_responses": true,
"available_from": null,
"available_until": null,
"self_service": false,
"require_user": false,
"require_request": false,
"anonymous_responses": false,
"can_choose_linked_model": false,
"user_response_limit": null,
"total_response_limit": null,
"response_review": "review",
"enable_sms_verification": false,
"redirect_url": null,
"thank_you_message": null,
"custom_css": null,
"fee_id": null,
"fee_amount": null,
"can_charge_to_account": false,
"default_localization_id": null,
"retired_by_id": null,
"retired_at": null,
"added_at": null,
"added_by_id": null
},
"response": {
"object": "form_response",
"id": 1,
"form_id": 1,
"form_version_id": 1,
"form_response_batch_id": null,
"person_id": 10,
"first_name": null,
"last_name": null,
"email": null,
"review": "review",
"status": "submitted",
"needs_review": null,
"needs_resubmit": null,
"fee_id": null,
"fee_amount": null,
"fee_discount": null,
"can_charge_to_account": false,
"fee_status": "unpaid",
"charge_method": null,
"sales_receipt_id": null,
"started_at": "2022-07-13T23:07:51+00:00",
"submitted_at": "2022-07-13T23:08:31+00:00",
"decision_by_id": null,
"decision_at": null,
"localization_id": null,
"requested_by_id": null,
"requested_at": null,
"added_at": "2022-07-13T23:07:51+00:00",
"respondent_url": "https:\/\/yourschool.populiweb.com\/router\/forms\/respond\/g795538da7a2293a0f77a7a697b178cc281eaf34e1c8ac6c5b784920d90c6944c03ac9ff54c31fc4b06ac3952ebc36969975080cc106f69f060ccb76abb9"
},
"sandbox": true
}
}
Form Response Respondent Updated
Whenever a form response respondent is changed.
{
"id": "1dc1cea15916a28c2fab5609a9e6fb54",
"event": "form_response_respondent_updated",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"lock_student": {
"object": "lock_student",
"id": 1,
"person_id": 2,
"lock_type_id": 1,
"reason": "Unpaid invoices.",
"note": null,
"added_at": "2022-07-13T17:58:35+00:00",
"added_by_id": 16
},
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Form Response Status Updated
Whenever a submitted form response's status is updated.
{
"id": "a2ae9f486f3b528ce39b32437b374339",
"event": "form_response_status_updated",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"transfer_credit": {
"object": "transfer_credit",
"id": 1,
"person_id": 1,
"transfer_institution_id": 1,
"description": "Spanish 1",
"credits": 2,
"hours": null,
"attendance_hours": null,
"clinical_hours": null,
"fulfills_program_requirements": true,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"affects_standing": true,
"course_number": "SPAN101",
"course_name": "Spanish 1",
"applied_date": null,
"effective_date": null,
"course_group_id": null,
"catalog_course_id": 687,
"status": "approved",
"status_at": null,
"status_by_id": null,
"organization_id": 1,
"organization_name": "The Oxford School",
"added_at": null,
"added_by_id": null,
"updated_at": null,
"updated_by_id": null
},
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Form Response Submitted
Whenever a form response is submitted.
{
"id": "04911d7718383a41636a05cf9d2d082f",
"event": "form_response_submitted",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"form": {
"object": "form",
"id": 1,
"current_version_id": 1,
"type": "form",
"name": "Form",
"description": null,
"image_file_id": null,
"published": true,
"accept_responses": true,
"available_from": null,
"available_until": null,
"self_service": false,
"require_user": false,
"require_request": false,
"anonymous_responses": false,
"can_choose_linked_model": false,
"user_response_limit": null,
"total_response_limit": null,
"response_review": "review",
"enable_sms_verification": false,
"redirect_url": null,
"thank_you_message": null,
"custom_css": null,
"fee_id": null,
"fee_amount": null,
"can_charge_to_account": false,
"default_localization_id": null,
"retired_by_id": null,
"retired_at": null,
"added_at": null,
"added_by_id": null
},
"response": {
"object": "form_response",
"id": 1,
"form_id": 1,
"form_version_id": 1,
"form_response_batch_id": null,
"person_id": 10,
"first_name": null,
"last_name": null,
"email": null,
"review": "review",
"status": "submitted",
"needs_review": null,
"needs_resubmit": null,
"fee_id": null,
"fee_amount": null,
"fee_discount": null,
"can_charge_to_account": false,
"fee_status": "unpaid",
"charge_method": null,
"sales_receipt_id": null,
"started_at": "2022-07-13T23:07:51+00:00",
"submitted_at": "2022-07-13T23:08:31+00:00",
"decision_by_id": null,
"decision_at": null,
"localization_id": null,
"requested_by_id": null,
"requested_at": null,
"added_at": "2022-07-13T23:07:51+00:00",
"respondent_url": "https:\/\/yourschool.populiweb.com\/router\/forms\/respond\/g795538da7a2293a0f77a7a697b178cc281eaf34e1c8ac6c5b784920d90c6944c03ac9ff54c31fc4b06ac3952ebc36969975080cc106f69f060ccb76abb9"
},
"sandbox": true
}
}
Group Bulletin Board Comment Added
Whenever someone comments on an existing post in a group bulletin board.
{
"id": "0e7a976b998b9ab0ad6e5d2053947c3c",
"event": "group_bulletin_board_comment_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"group": {
"object": "group",
"id": 1,
"parent_id": null,
"name": "Seagulls, stop it now",
"description": null,
"membership": "open",
"can_invite": "members",
"can_bulletin_board_posts": "members",
"can_add_discussions": "members",
"can_upload_files": "members",
"enable_chat": true,
"public": true,
"official": false,
"image_file_id": null,
"status": "active",
"status_by_id": null,
"status_at": null,
"added_at": "2019-01-22T23:50:55+00:00",
"added_by_id": 11
},
"post": {
"object": "post",
"id": 6,
"content": "Career fair this Saturday!",
"owner_type": "person",
"owner_id": null,
"added_by_instructor": false,
"edited_at": null,
"edited_post_id": null,
"file_id": null,
"added_at": "2020-04-15T18:36:01+00:00",
"added_by_id": 1
},
"comment": {
"object": "post_comment",
"id": 6,
"parent_comment_id": null,
"post_id": 7,
"content": "I like how you state the thesis clearly.",
"edited_at": null,
"edited_comment_id": null,
"added_at": "2020-04-14T15:33:42+00:00",
"added_by_id": 1257
},
"author": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Group Bulletin Board Post Added
Whenever someone posts to a group bulletin board.
{
"id": "c3a64ae9953677307fda9a467d589ffd",
"event": "group_bulletin_board_post_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"group": {
"object": "group",
"id": 1,
"parent_id": null,
"name": "Seagulls, stop it now",
"description": null,
"membership": "open",
"can_invite": "members",
"can_bulletin_board_posts": "members",
"can_add_discussions": "members",
"can_upload_files": "members",
"enable_chat": true,
"public": true,
"official": false,
"image_file_id": null,
"status": "active",
"status_by_id": null,
"status_at": null,
"added_at": "2019-01-22T23:50:55+00:00",
"added_by_id": 11
},
"post": {
"object": "post",
"id": 6,
"content": "Career fair this Saturday!",
"owner_type": "person",
"owner_id": null,
"added_by_instructor": false,
"edited_at": null,
"edited_post_id": null,
"file_id": null,
"added_at": "2020-04-15T18:36:01+00:00",
"added_by_id": 1
},
"author": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Group Discussion Added
Whenever someone adds a discussion in a group.
{
"id": "d786aa5418ea5b0fd10c73390ef350e2",
"event": "group_discussion_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"group": {
"object": "group",
"id": 1,
"parent_id": null,
"name": "Seagulls, stop it now",
"description": null,
"membership": "open",
"can_invite": "members",
"can_bulletin_board_posts": "members",
"can_add_discussions": "members",
"can_upload_files": "members",
"enable_chat": true,
"public": true,
"official": false,
"image_file_id": null,
"status": "active",
"status_by_id": null,
"status_at": null,
"added_at": "2019-01-22T23:50:55+00:00",
"added_by_id": 11
},
"discussion": {
"object": "forum_topic",
"id": 1,
"owner_type": "lesson",
"owner_id": 17071,
"assignment_id": null,
"lesson_page_section_id": 126289,
"title": "How might one keep it real?",
"topic": "This discussion covers reality and how to keep it.",
"peer_rating": false,
"post_first": false,
"max_comments": null,
"max_replies": null,
"published": true,
"grade_comments": null,
"grade_replies": null,
"available_at": null,
"disable_comment_edits": false,
"comments_closed": false,
"comments_closed_at": null,
"author_id": 18493,
"faculty_added": false,
"file_id": null,
"last_activity": "2011-12-01T18:16:23+00:00",
"last_activity_by_id": 8397,
"import_id": null,
"auto_grade_at": null,
"auto_grade_job_id": null,
"pin": false,
"pin_until": null,
"added_at": "2010-09-10T22:44:58+00:00",
"added_by_id": 18493,
"updated_at": null,
"updated_by_id": null,
"deleted_at": null,
"deleted_by_id": null
},
"author": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Group Discussion Comment Added
Whenever someone comments on an existing post in a group discussion.
{
"id": "fdadb11f16518248e9d0fad894425997",
"event": "group_discussion_reply_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"group": {
"object": "group",
"id": 1,
"parent_id": null,
"name": "Seagulls, stop it now",
"description": null,
"membership": "open",
"can_invite": "members",
"can_bulletin_board_posts": "members",
"can_add_discussions": "members",
"can_upload_files": "members",
"enable_chat": true,
"public": true,
"official": false,
"image_file_id": null,
"status": "active",
"status_by_id": null,
"status_at": null,
"added_at": "2019-01-22T23:50:55+00:00",
"added_by_id": 11
},
"discussion": {
"object": "forum_topic",
"id": 1,
"owner_type": "lesson",
"owner_id": 17071,
"assignment_id": null,
"lesson_page_section_id": 126289,
"title": "How might one keep it real?",
"topic": "This discussion covers reality and how to keep it.",
"peer_rating": false,
"post_first": false,
"max_comments": null,
"max_replies": null,
"published": true,
"grade_comments": null,
"grade_replies": null,
"available_at": null,
"disable_comment_edits": false,
"comments_closed": false,
"comments_closed_at": null,
"author_id": 18493,
"faculty_added": false,
"file_id": null,
"last_activity": "2011-12-01T18:16:23+00:00",
"last_activity_by_id": 8397,
"import_id": null,
"auto_grade_at": null,
"auto_grade_job_id": null,
"pin": false,
"pin_until": null,
"added_at": "2010-09-10T22:44:58+00:00",
"added_by_id": 18493,
"updated_at": null,
"updated_by_id": null,
"deleted_at": null,
"deleted_by_id": null
},
"post": {
"object": "forum_topic_comment",
"id": 7,
"topic_id": 1,
"parent_comment_id": null,
"comment": "Good question!",
"faculty_comment": false,
"edited_at": null,
"edited_comment_id": null,
"file_id": null,
"assignment_submission_grade_id": null,
"grade": null,
"added_by_name": "Dolce Miller",
"added_by_initials": "DM",
"added_by_image_file_id": null,
"added_at": "2019-08-17T17:50:32+00:00",
"added_by_id": 35,
"deleted_at": null,
"deleted_by_id": null
},
"comment": {
"object": "forum_topic_comment",
"id": 7,
"topic_id": 1,
"parent_comment_id": null,
"comment": "Good question!",
"faculty_comment": false,
"edited_at": null,
"edited_comment_id": null,
"file_id": null,
"assignment_submission_grade_id": null,
"grade": null,
"added_by_name": "Dolce Miller",
"added_by_initials": "DM",
"added_by_image_file_id": null,
"added_at": "2019-08-17T17:50:32+00:00",
"added_by_id": 35,
"deleted_at": null,
"deleted_by_id": null
},
"author": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Group Discussion Report
Whenever a group discussion or comment is reported as inappropriate.
{
"id": "ff9b7aa6268b1ae6e64fbc9d7f7a3983",
"event": "group_discussion_reported",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"meal_plan": {
"object": "meal_plan",
"id": 1,
"name": "Gold",
"amount": 1500,
"status": "active",
"external_account_id": 1,
"account_id": 1,
"added_at": null,
"added_by_id": null
},
"meal_plan_student": {
"object": "meal_plan_student",
"id": 6,
"term_id": 73,
"student_id": 61,
"plan_id": 1,
"amount": 1500,
"adjustment": 0,
"added_at": null,
"added_by_id": null
},
"sandbox": true
}
}
Group Invitation Requested
Whenever someone requests to be invited to a closed group.
{
"id": "1eb64c10152e22eb826e116aaf22e1e3",
"event": "group_invitation_requested",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"group": {
"object": "group",
"id": 1,
"parent_id": null,
"name": "Seagulls, stop it now",
"description": null,
"membership": "open",
"can_invite": "members",
"can_bulletin_board_posts": "members",
"can_add_discussions": "members",
"can_upload_files": "members",
"enable_chat": true,
"public": true,
"official": false,
"image_file_id": null,
"status": "active",
"status_by_id": null,
"status_at": null,
"added_at": "2019-01-22T23:50:55+00:00",
"added_by_id": 11
},
"requester": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Inquiry Added
Whenever a new inquiry is added.
{
"id": "24b54997a97714055568dd2c226f270e",
"event": "inquiry_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"inquiry": {
"object": "inquiry",
"id": 1,
"form_id": null,
"form_version_id": null,
"person_id": null,
"lead_id": null,
"first_name": "Homestar",
"middle_name": null,
"last_name": "Runner",
"email": "homestar@populi.co",
"phone": null,
"address_id": null,
"subject": "Email, scrollbuttons",
"content": "Yeah!",
"program_id": null,
"degree_id": null,
"specialization_id": null,
"academic_term_id": null,
"counselor_id": null,
"status": "waiting_on_us",
"closed_at": null,
"closed_by_id": null,
"lead_source_id": null,
"localization_id": null,
"added_on": "2013-03-15",
"added_at": "2013-03-15T21:06:03+00:00",
"added_by_id": null
},
"sandbox": true
}
}
Inquiry Linked to Person
Whenever an inquiry is linked to a person.
{
"id": "7e1d15e9ed583c226e0da29800efc943",
"event": "inquiry_linked_to_person",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"inquiry": {
"object": "inquiry",
"id": 1,
"form_id": null,
"form_version_id": null,
"person_id": null,
"lead_id": null,
"first_name": "Homestar",
"middle_name": null,
"last_name": "Runner",
"email": "homestar@populi.co",
"phone": null,
"address_id": null,
"subject": "Email, scrollbuttons",
"content": "Yeah!",
"program_id": null,
"degree_id": null,
"specialization_id": null,
"academic_term_id": null,
"counselor_id": null,
"status": "waiting_on_us",
"closed_at": null,
"closed_by_id": null,
"lead_source_id": null,
"localization_id": null,
"added_on": "2013-03-15",
"added_at": "2013-03-15T21:06:03+00:00",
"added_by_id": null
},
"sandbox": true
}
}
Inquiry Representative Assigned
Whenever an Inquiry is assigned to a representative.
{
"id": "786a430f448b8cb480b70ebe919eb097",
"event": "inquiry_representative_assigned",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"room_plan": {
"object": "room_plan",
"id": 1,
"name": "Palace",
"capacity": true,
"amount": 1250,
"added_at": null,
"added_by_id": null
},
"room": {
"object": "room",
"id": 1,
"building_id": 3,
"name": "Administrative Offices",
"floor": "1",
"capacity": null,
"default_room_plan_id": null,
"retired_at": null,
"retired_by_id": null,
"added_at": null,
"added_by_id": null
},
"building": {
"object": "building",
"id": 1,
"campus_id": 8,
"name": "Example Building",
"street": "5555 Test Avenue",
"city": "Example City",
"state": "XY",
"postal": "00000",
"country": "US",
"floors": 2,
"basement_floors": 1,
"retired_at": null,
"retired_by_id": null,
"added_at": null,
"added_by_id": null
},
"room_plan_student": {
"object": "room_plan_student",
"id": 6,
"term_id": 73,
"student_id": 2388,
"plan_id": 4,
"room_id": null,
"capacity_used": 1,
"added_at": null,
"added_by_id": null
},
"sandbox": true
}
}
Integration Log Error
Whenever an error is recorded to the integration log.
{
"id": "4e3fc22112923093f941a7a9451a3200",
"event": "integration_log_error",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"application": {
"object": "application",
"id": 1,
"cloned_from_id": null,
"person_id": null,
"lead_id": null,
"first_name": "Homestar",
"middle_name": null,
"last_name": "Runner",
"email": "homestar@populi.co",
"phone": null,
"address_id": null,
"application_template_id": 3,
"form_version_id": 2,
"counselor_id": null,
"program_id": 1,
"degree_seeking": true,
"degree_id": null,
"specialization_id": null,
"academic_term_id": 1,
"campus_id": null,
"lead_source_id": null,
"started_on": "2013-03-19",
"submitted_at": null,
"pending_decision_on": null,
"decision_on": null,
"confirmed_on": null,
"withdrawn_on": null,
"expected_enrollment": "full_time",
"status": "in_progress",
"provisional": false,
"provisional_note": null,
"hs_grad_date": null,
"fee_status": "unpaid",
"fee_id": null,
"fee_amount": null,
"fee_discount": null,
"fee_payment": "before_start",
"sales_receipt_id": null,
"letter_printed_at": null,
"letter_printed_by_id": null,
"prospect_activity_at": null,
"staff_activity_at": null,
"percent_complete": 0,
"active_questions": null,
"localization_id": null,
"added_at": "2013-03-19T21:20:18+00:00",
"added_by_id": null,
"applicant_url": "https:\/\/yourschool.populiweb.com\/router\/admissions\/onlineapplications\/show\/g64c8ee3f6da7a2293a0f77a7a697b178cc281eaf34e1c8ac6c5b784920d90c6944c03ac9ff54c31fc4b06ac3952ebc36969975080cc106f69f060ccb76abb9"
},
"sandbox": true
}
}
Invoice Paid
Whenever an invoice is paid off entirely.
{
"id": "2de764ec62c4d5d4d7ae7cedf8087854",
"event": "invoice_paid",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"invoice": {
"object": "invoice",
"id": 7,
"actor_type": "person",
"actor_id": 1,
"number": 1,
"description": null,
"transaction_id": 9,
"amount": 1234.56,
"due_on": "2009-04-07",
"status": "unpaid",
"marked_uncollectible_on": null,
"posted_on": "2015-03-10",
"academic_term_id": null,
"items": [
{
"object": "invoice_item",
"id": 6,
"invoice_id": 7,
"item_type": "fee",
"item_id": 9,
"name": null,
"amount": 20,
"description": "Parking Ticket"
}
]
},
"sandbox": true
}
}
Invoice Posted
Whenever an invoice is posted to someone's account.
{
"id": "9fb2bfb618707c9674c11aab41e27ae0",
"event": "invoice_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"invoice": {
"object": "invoice",
"id": 7,
"actor_type": "person",
"actor_id": 1,
"number": 1,
"description": null,
"transaction_id": 9,
"amount": 1234.56,
"due_on": "2009-04-07",
"status": "unpaid",
"marked_uncollectible_on": null,
"posted_on": "2015-03-10",
"academic_term_id": null,
"items": [
{
"object": "invoice_item",
"id": 6,
"invoice_id": 7,
"item_type": "fee",
"item_id": 9,
"name": null,
"amount": 20,
"description": "Parking Ticket"
}
]
},
"sandbox": true
}
}
ISIR Imported
Whenever an ISIR is imported.
Example payload currently unavailable for this event.
Lead Added
Whenever a new lead is added.
{
"id": "ba18100fb67b0f0f0ff0d54e3d0549cc",
"event": "lead_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"lead": {
"object": "lead",
"id": 1,
"person_id": 1,
"status": "prospect",
"program_id": null,
"degree_id": null,
"specialization_id": null,
"academic_term_id": null,
"active": true,
"inactive_on": "2013-10-02",
"lead_source_id": null,
"ceeb_code": null,
"source_comment": null,
"education_level_id": 0,
"declined_reason_id": null,
"declined_reason_comment": null,
"counselor_id": 1011,
"highschool_graduation_date": null,
"most_recent": false,
"added_on": "2013-10-02",
"import_id": null,
"added_at": "2013-10-02T20:37:53+00:00",
"added_by_id": 185755,
"updated_at": "2013-10-02T14:35:29+00:00",
"updated_by_id": 1999
},
"sandbox": true
}
}
Lead Representative Assigned
Whenever a Lead is assigned to a representative.
{
"id": "36ed8ef3d96e5714edf67d8e1907dc7a",
"event": "lead_representative_assigned",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"room_plan": {
"object": "room_plan",
"id": 1,
"name": "Palace",
"capacity": true,
"amount": 1250,
"added_at": null,
"added_by_id": null
},
"room": {
"object": "room",
"id": 1,
"building_id": 3,
"name": "Administrative Offices",
"floor": "1",
"capacity": null,
"default_room_plan_id": null,
"retired_at": null,
"retired_by_id": null,
"added_at": null,
"added_by_id": null
},
"building": {
"object": "building",
"id": 1,
"campus_id": 8,
"name": "Example Building",
"street": "5555 Test Avenue",
"city": "Example City",
"state": "XY",
"postal": "00000",
"country": "US",
"floors": 2,
"basement_floors": 1,
"retired_at": null,
"retired_by_id": null,
"added_at": null,
"added_by_id": null
},
"room_plan_student": {
"object": "room_plan_student",
"id": 6,
"term_id": 73,
"student_id": 2388,
"plan_id": 4,
"room_id": null,
"capacity_used": 1,
"added_at": null,
"added_by_id": null
},
"sandbox": true
}
}
Lead Status Updated
Whenever a leads status is updated (e.g. Prospect to Inquiry).
{
"id": "c31e5dfa24dc45841ac3ec6faacfc7b0",
"event": "lead_status_updated",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"lead": {
"object": "lead",
"id": 1,
"person_id": 1,
"status": "prospect",
"program_id": null,
"degree_id": null,
"specialization_id": null,
"academic_term_id": null,
"active": true,
"inactive_on": "2013-10-02",
"lead_source_id": null,
"ceeb_code": null,
"source_comment": null,
"education_level_id": 0,
"declined_reason_id": null,
"declined_reason_comment": null,
"counselor_id": 1011,
"highschool_graduation_date": null,
"most_recent": false,
"added_on": "2013-10-02",
"import_id": null,
"added_at": "2013-10-02T20:37:53+00:00",
"added_by_id": 185755,
"updated_at": "2013-10-02T14:35:29+00:00",
"updated_by_id": 1999
},
"application": {
"object": "application",
"id": 1,
"cloned_from_id": null,
"person_id": null,
"lead_id": null,
"first_name": "Homestar",
"middle_name": null,
"last_name": "Runner",
"email": "homestar@populi.co",
"phone": null,
"address_id": null,
"application_template_id": 3,
"form_version_id": 2,
"counselor_id": null,
"program_id": 1,
"degree_seeking": true,
"degree_id": null,
"specialization_id": null,
"academic_term_id": 1,
"campus_id": null,
"lead_source_id": null,
"started_on": "2013-03-19",
"submitted_at": null,
"pending_decision_on": null,
"decision_on": null,
"confirmed_on": null,
"withdrawn_on": null,
"expected_enrollment": "full_time",
"status": "in_progress",
"provisional": false,
"provisional_note": null,
"hs_grad_date": null,
"fee_status": "unpaid",
"fee_id": null,
"fee_amount": null,
"fee_discount": null,
"fee_payment": "before_start",
"sales_receipt_id": null,
"letter_printed_at": null,
"letter_printed_by_id": null,
"prospect_activity_at": null,
"staff_activity_at": null,
"percent_complete": 0,
"active_questions": null,
"localization_id": null,
"added_at": "2013-03-19T21:20:18+00:00",
"added_by_id": null,
"applicant_url": "https:\/\/yourschool.populiweb.com\/router\/admissions\/onlineapplications\/show\/g64c8ee3f6da7a2293a0f77a7a697b178cc281eaf34e1c8ac6c5b784920d90c6944c03ac9ff54c31fc4b06ac3952ebc36969975080cc106f69f060ccb76abb9"
},
"sandbox": true
}
}
Library Resource Lost
Whenever a library resource is lost
{
"id": "44445e47e18953cdce2883d54c1f0178",
"event": "library_resource_lost",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"bookstore_order": {
"object": "bookstore_order",
"id": 10,
"type": "",
"user_id": null,
"first_name": "Testy",
"last_name": "McTest",
"email": "test@example.com",
"phone": "555-0100 x 123",
"transaction_id": null,
"shipping_method_id": null,
"carrier_id": 0,
"tracking_number": null,
"secret": "a4afg174197c5a",
"source": "internet",
"ship_to_name": null,
"ship_to_street": "111 Test Lane",
"ship_to_city": "Example City",
"ship_to_state": "XY",
"ship_to_postal": "00000",
"ship_to_country": null,
"is_picking_up": true,
"item_total": 109.5,
"item_discount": 0,
"return_item_total": 0,
"shipping": 0,
"shipping_discount": 0,
"tax_exempt": false,
"tax": 7.11,
"return_tax": 0,
"total": 116.61,
"status": "fulfilled",
"payment_gateway_id": null,
"placed_at": "2019-11-05T20:58:06+00:00",
"fulfilled_at": null,
"voided_at": null,
"academic_term_id": null,
"online_amount": 0,
"cash_amount": 0,
"check_amount": 0,
"on_account_amount": 0,
"refund_on_account_amount": 0,
"refund_tax_on_account_amount": 0,
"check_reference_number": null,
"special_instructions": null,
"tax_on_account": false,
"shipping_on_account": false,
"suspended_by_id": null,
"suspended_at": null,
"added_at": "2009-11-11T19:57:53+00:00",
"added_by_id": null
},
"sandbox": true
}
}
New Transfer Credits Awaiting Approval
Whenever someone adds a transfer credit that needs to be approved by a Registrar or an Academic Admin.
{
"id": "d05acf448da260af6c9cbf77fa61ff70",
"event": "transfer_credit_awaiting_approval",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"course": {
"object": "course_offering",
"id": 21908,
"academic_term_id": 4,
"campus_id": null,
"finalized": false,
"finalized_at": null,
"max_enrolled": null,
"max_auditors": null,
"roster_visibility": true,
"start_date": "2022-05-20",
"end_date": "2022-10-08",
"add_drop_time": null,
"published": true,
"open_to_students_date": null,
"closed_to_students_date": null,
"faculty_can_manage_roster": false,
"faculty_can_override_enrollment": false,
"students_can_add_discussions": true,
"disable_student_bulletin_board_posts": false,
"allow_auditor_assignments": false,
"allow_auditor_attendance": false,
"allow_auditor_evaluations": false,
"waiting_list_management": "automatic",
"image_file_id": null,
"show_progress_to_students": false,
"catalog_courses": [
{
"object": "catalog_course",
"id": 1,
"course_offering_id": 21908,
"catalog_course_id": 688,
"primary": true,
"abbrv": "LAT101",
"name": "Beginning Latin I",
"description": null,
"section": "1",
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"affects_standing": true,
"affects_full_time_status": true,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"fulfills_program_requirements": true,
"minimum_attendance": null,
"hide_self_register": false,
"self_enroll": "yes",
"self_audit": true,
"delivery_methods": [
{
"object": "course_delivery_method",
"id": 5,
"name": "Hybrid Online",
"distance_education": false,
"status": "active",
"primary": 1,
"added_at": null,
"added_by_id": null
}
],
"added_at": null,
"added_by_id": null
}
]
},
"assignment": {
"object": "assignment",
"id": 29656,
"course_offering_id": 21908,
"name": "Midterm Test",
"points": 100,
"due_at": null,
"available_from": null,
"available_until": null,
"published": true,
"description": "This is a test",
"assignment_group_id": null,
"lesson_id": null,
"type": "test",
"allowed_file_types": null,
"visible_to_students_before_available": true,
"extra_credit": false,
"pass_fail": false,
"mandatory_pass": false,
"peer_review": false,
"anonymous_reviews": true,
"submission_visibility": "always",
"randomize_submissions": false,
"review_visibility": "never",
"allow_review_comments": false,
"peer_grade": false,
"grade_submissions": null,
"grade_reviews": null,
"reviews_due_at": null,
"reviews_closed_at": null,
"auto_check_submissions_for_plagiarism": false,
"plagiarism_checks_visible_to_students": false,
"plagiarism_check_provider": null,
"release_grades": "yes",
"release_grades_at": null,
"added_at": null,
"added_by_id": null
},
"assignment_test": {
"object": "assignment_test",
"id": 434,
"assignment_id": 29656,
"time_limit": 1800,
"retake_policy": "keep_highest",
"retakes": 0,
"answers_visible": "after_taking",
"proctored": "not_proctored",
"lti_proctor_id": null,
"import_id": null,
"test_submit_feedback": "feedback",
"test_end_feedback": "answers",
"course_end_feedback": "answers",
"points_type": "fixed",
"integrity_controls": false,
"full_screen": false,
"copy_paste": false,
"webcam": false,
"password": null,
"sections": [
{
"object": "assignment_test_section",
"id": 1975,
"test_id": 434,
"type": "question",
"link_id": 712,
"content": null,
"weight_coef": 0.25,
"points": 25,
"extra_credit": false,
"section_order": 1,
"num_questions": null,
"import_id": null,
"added_at": null,
"added_by_id": null
},
{
"object": "assignment_test_section",
"id": 1976,
"test_id": 434,
"type": "question",
"link_id": 713,
"content": null,
"weight_coef": 0.25,
"points": 25,
"extra_credit": false,
"section_order": 3,
"num_questions": null,
"import_id": null,
"added_at": null,
"added_by_id": null
},
{
"object": "assignment_test_section",
"id": 1977,
"test_id": 434,
"type": "title",
"link_id": null,
"content": "Heading 1",
"weight_coef": 0,
"points": 0,
"extra_credit": false,
"section_order": 5,
"num_questions": null,
"import_id": null,
"added_at": null,
"added_by_id": null
},
{
"object": "assignment_test_section",
"id": 1978,
"test_id": 434,
"type": "question",
"link_id": 714,
"content": null,
"weight_coef": 0.25,
"points": 25,
"extra_credit": false,
"section_order": 7,
"num_questions": null,
"import_id": null,
"added_at": null,
"added_by_id": null
},
{
"object": "assignment_test_section",
"id": 1979,
"test_id": 434,
"type": "question",
"link_id": 715,
"content": null,
"weight_coef": 0.1,
"points": 10,
"extra_credit": false,
"section_order": 9,
"num_questions": null,
"import_id": null,
"added_at": null,
"added_by_id": null
},
{
"object": "assignment_test_section",
"id": 1980,
"test_id": 434,
"type": "question",
"link_id": 716,
"content": null,
"weight_coef": 0.05,
"points": 5,
"extra_credit": false,
"section_order": 11,
"num_questions": null,
"import_id": null,
"added_at": null,
"added_by_id": null
},
{
"object": "assignment_test_section",
"id": 1981,
"test_id": 434,
"type": "question",
"link_id": 717,
"content": null,
"weight_coef": 0.1,
"points": 10,
"extra_credit": false,
"section_order": 13,
"num_questions": null,
"import_id": null,
"added_at": null,
"added_by_id": null
},
{
"object": "assignment_test_section",
"id": 1982,
"test_id": 434,
"type": "text",
"link_id": null,
"content": "The next question is for extra credit.",
"weight_coef": 0,
"points": 0,
"extra_credit": false,
"section_order": 15,
"num_questions": null,
"import_id": null,
"added_at": null,
"added_by_id": null
},
{
"object": "assignment_test_section",
"id": 1983,
"test_id": 434,
"type": "question",
"link_id": 718,
"content": null,
"weight_coef": 0.05,
"points": 5,
"extra_credit": true,
"section_order": 17,
"num_questions": null,
"import_id": null,
"added_at": null,
"added_by_id": null
}
]
},
"assignment_test_instance": {
"object": "assignment_test_instance",
"id": 876,
"student_id": 1,
"test_id": 434,
"grade_coef": 0.9875,
"start_time": "2012-10-10T22:58:01+00:00",
"end_time": "2012-10-10T22:59:35+00:00",
"start_window": "2012-10-01T17:00:00+00:00",
"end_window": "2013-10-31T19:00:00+00:00",
"time_limit": 1800,
"proctored": false,
"proctor_id": null,
"proctoring_status": null,
"integrity_controls": false,
"full_screen": false,
"copy_paste": false,
"webcam": false
},
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Online Reference Submitted
Whenever a reference is submitted for an applicant.
{
"id": "0d5505f58795839d04638de4caac0c58",
"event": "online_reference_submitted",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"online_reference": {
"object": "online_reference",
"id": 5,
"first_name": "Homestar",
"middle_name": null,
"last_name": "Runner",
"email": "homestar@populi.co",
"phone": "(555) 555-8585",
"online_reference_form_id": 1,
"form_version_id": 5,
"submitted_at": "2013-04-19T00:00:00+00:00",
"status": "submitted",
"letter_printed_at": null,
"letter_printed_by_id": null,
"added_at": null,
"added_by_id": null
},
"application": {
"object": "application",
"id": 1,
"cloned_from_id": null,
"person_id": null,
"lead_id": null,
"first_name": "Homestar",
"middle_name": null,
"last_name": "Runner",
"email": "homestar@populi.co",
"phone": null,
"address_id": null,
"application_template_id": 3,
"form_version_id": 2,
"counselor_id": null,
"program_id": 1,
"degree_seeking": true,
"degree_id": null,
"specialization_id": null,
"academic_term_id": 1,
"campus_id": null,
"lead_source_id": null,
"started_on": "2013-03-19",
"submitted_at": null,
"pending_decision_on": null,
"decision_on": null,
"confirmed_on": null,
"withdrawn_on": null,
"expected_enrollment": "full_time",
"status": "in_progress",
"provisional": false,
"provisional_note": null,
"hs_grad_date": null,
"fee_status": "unpaid",
"fee_id": null,
"fee_amount": null,
"fee_discount": null,
"fee_payment": "before_start",
"sales_receipt_id": null,
"letter_printed_at": null,
"letter_printed_by_id": null,
"prospect_activity_at": null,
"staff_activity_at": null,
"percent_complete": 0,
"active_questions": null,
"localization_id": null,
"added_at": "2013-03-19T21:20:18+00:00",
"added_by_id": null,
"applicant_url": "https:\/\/yourschool.populiweb.com\/router\/admissions\/onlineapplications\/show\/g64c8ee3f6da7a2293a0f77a7a697b178cc281eaf34e1c8ac6c5b784920d90c6944c03ac9ff54c31fc4b06ac3952ebc36969975080cc106f69f060ccb76abb9"
},
"application_template": {
"object": "application_template",
"id": 3,
"current_version_id": 2,
"name": "Test v3",
"type": "application",
"published": true,
"custom_css": null,
"show_online": true,
"require_address": false,
"fee_id": null,
"fee_amount": 75,
"fee_payment": "before_start",
"allow_undecided": true,
"enable_sms_verification": true,
"redirect_url": null,
"thank_you_message": null,
"initial_email_template_id": null,
"enable_initial_email": true,
"retired_by_id": null,
"retired_at": null,
"default_localization_id": null,
"added_at": null,
"added_by_id": null
},
"sandbox": true
}
}
Organization Added
Whenever a new organization is added.
{
"id": "4f2d9575e3f3651c6f0c7023828d4dee",
"event": "contact_organization_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"contact_organization": {
"object": "organization",
"id": 1,
"name": "The Oxford School",
"image_file_id": null,
"industry_id": null,
"ceeb_code": null,
"notification_email_id": null,
"portal_secret": null,
"portal_secret_expires_at": null,
"info_changed_at": null,
"import_id": null,
"added_at": null,
"added_by_id": null,
"type": "College"
},
"sandbox": true
}
}
Organization Deleted
Whenever an organization is deleted.
{
"id": "faace98d8b1fd4a7ebabe664d9909dd0",
"event": "contact_organization_deleted",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"contact_organization": {
"object": "organization",
"id": 1,
"name": "The Oxford School",
"image_file_id": null,
"industry_id": null,
"ceeb_code": null,
"notification_email_id": null,
"portal_secret": null,
"portal_secret_expires_at": null,
"info_changed_at": null,
"import_id": null,
"added_at": null,
"added_by_id": null,
"type": "College"
},
"sandbox": true
}
}
Organization Updated
Whenever basic information about an organization (phone, address, name, etc) is updated.
{
"id": "dd128021850c6fa602f178730a8bb802",
"event": "contact_organization_updated",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"contact_organization": {
"object": "organization",
"id": 1,
"name": "The Oxford School",
"image_file_id": null,
"industry_id": null,
"ceeb_code": null,
"notification_email_id": null,
"portal_secret": null,
"portal_secret_expires_at": null,
"info_changed_at": null,
"import_id": null,
"added_at": null,
"added_by_id": null,
"type": "College"
},
"sandbox": true
}
}
Password Changed
Whenever a user changes their password.
{
"id": "356f7b5231919e055c505bd9f3f2b168",
"event": "password_changed",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"user": {
"object": "user",
"id": 16,
"username": "academic.admin",
"organization_domain_id": null,
"is_active": true,
"blocked_reason": "",
"last_activity_at": null,
"login_type": "ALL"
},
"sandbox": true
}
}
Payment Received
Whenever a payment is received (online, recurring, manually entered by college staff, from an aid source, etc).
{
"id": "63a6a7c6b44cbde6e13352e8708f30ce",
"event": "payment_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"payment": {
"object": "payment",
"id": 5,
"student_id": 1,
"transaction_id": 21,
"number": 1,
"amount": 100,
"online_payment_id": null,
"service_fee_amount": 0,
"paid_by_type": "person",
"paid_by_id": 2,
"aid_type_id": null,
"refund_source": null,
"reference_number": null,
"receipt_number": "ce9e16ad2e",
"amount_available": 100,
"currency": "USD",
"exchange_rate": null,
"home_currency_amount": 100,
"recurring_money_transfer_id": null,
"aid_disbursement_id": null,
"treat_as_aid": false,
"organization_name": null,
"method": "other"
},
"sandbox": true
}
}
Person Added
Whenever a new person is added.
{
"id": "85bcea1291149a7734c9670fcf3cf31b",
"event": "person_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Person Custom Field Data Changed
Whenever a person's custom field data is changed.
{
"id": "a1a9b6b3cd1f5f4b2a0b9015991cb89a",
"event": "person_custom_field_data_changed",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"custom_field": {
"object": "custom_info_field",
"id": 18,
"name": "Business membership number",
"input_type": "text_area",
"type": "organization",
"description": null,
"value_permissions": "default"
},
"academic_term": {
"object": "academic_term",
"id": 8,
"academic_year_id": 4,
"name": "Spring 2010",
"display_name": "Spring 2010 2009-2010",
"start_date": "2010-02-01",
"end_date": "2010-05-15",
"grades_date": "2010-05-10",
"add_drop_time": "2010-02-15T00:00:00+00:00",
"enrollment_start_time": "2010-01-01T00:00:00+00:00",
"enrollment_end_time": null,
"max_enrolled_credits": null,
"max_enrolled_hours": null,
"max_audit_credits": null,
"max_audit_hours": null,
"can_overlap_dates": false,
"level": "single",
"academic_term_type_id": null,
"is_for_transcript": true,
"is_for_billing": true,
"is_for_campus_life": true,
"is_entrance_term": true,
"evaluations_available_from": null,
"evaluations_available_to": null,
"evaluations_lock_grades_at": null,
"online_registration_delay_until": null,
"online_registration_randomization_seconds": 0,
"evaluations_lock_grades_until": null,
"evaluations_available_to_faculty": null,
"lms_sync": null,
"external_id": null,
"start_year": 2009,
"end_year": 2010,
"added_at": null,
"added_by_id": null,
"type": "standard"
},
"custom_field_data": {
"object": "custom_info_data",
"id": 1,
"custom_info_field_id": 11,
"academic_term_id": null,
"value": "Silver Ford Escape",
"owner_id": 1,
"import_id": null,
"custom_info_field": {
"object": "custom_info_field",
"id": 11,
"name": "Car Model",
"input_type": "text_area",
"type": "person",
"description": null,
"value_permissions": "default"
},
"added_at": "2022-01-01T00:05:30+00:00",
"added_by_id": 2,
"updated_at": "2022-01-01T00:05:30+00:00",
"updated_by_id": 2,
"option_value": null
},
"sandbox": true
}
}
Person Deleted
Whenever a person is deleted.
{
"id": "cc78366864fd1a26f67476ca3e953036",
"event": "person_deleted",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Person Updated
Whenever basic information about a person (phone, address, name, etc) is updated.
{
"id": "c600962b0813889b7094cea118c77b05",
"event": "person_updated",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"affected_field": {
"object": "person_updated_affected_data",
"id": 2,
"model_type_id": 1,
"type": "ADDRESS"
},
"name_field": {
"object": "person_updated_trigger_name_field",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"address_field": {
"object": "address",
"id": 1,
"owner_id": 1,
"owner_type": "org",
"street": "9000 Test Boulevard",
"city": "Example City",
"state": "XY",
"postal": "00000",
"country": "US",
"type": "main",
"primary": true,
"most_recent_by_type": false,
"old": false,
"public": true,
"synced_from": null,
"import_id": null,
"added_at": null,
"added_by_id": null
},
"email_field": {
"object": "email_address",
"id": 1,
"email": "testaddress@nowhere.com",
"owner_type": "person",
"owner_id": 1,
"type": "home",
"primary": false,
"most_recent_by_type": false,
"old": false,
"system": false,
"public": true,
"synced_from": null,
"delivery_problem": null,
"delivery_problem_at": null,
"delivery_problem_info": null,
"verified_at": null,
"unsubscribed_at": null,
"import_id": null,
"added_at": null,
"added_by_id": null
},
"phone_field": {
"object": "phone_number",
"id": 3,
"owner_id": 1,
"owner_type": "organization",
"number": "333.555.6666 x 091",
"type": "work",
"primary": true,
"most_recent_by_type": false,
"old": false,
"public": true,
"synced_from": null,
"ext": null,
"import_id": null,
"added_at": null,
"added_by_id": null,
"is_sms_verified": false
},
"website_field": {
"object": "website",
"id": 2179,
"owner_id": 2,
"owner_type": "person",
"website": "http:\/\/coolschool.populiweb.com",
"primary": true,
"old": false,
"public": true,
"synced_from": null,
"added_at": null,
"added_by_id": null
},
"unsubscribe_field": {
"object": "unsubscribe",
"id": 3,
"email_address": "example@domain.com",
"mailing_list_id": null,
"generated_at": "2011-12-16T19:30:47+00:00",
"remote_ip": null,
"added_at": "2011-12-16T19:30:47+00:00",
"added_by_id": null
},
"status_field": {
"object": "person_updated_trigger_status_field",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Recurring Payment Status Change
Whenever recurring payment's status is changed.
{
"id": "ca75c4140601d39b55596dab4a5a74a0",
"event": "recurring_payment_status_change",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"recurring_money_transfer": {
"object": "recurring_money_transfer",
"id": 2,
"type": "donation",
"donor_id": 1,
"student_id": null,
"payer_type": null,
"payer_id": null,
"payment_plan_student_id": null,
"treat_as_aid": false,
"pay_beyond_balance": false,
"payment_method": "card",
"gateway_token_provider": "stripe",
"payment_gateway_id": null,
"gateway_customer_token": "cus_MLxeHuvTzFyb2N",
"gateway_source_token": "card_1Ld0FNGz1v34x3yFuC2B0L72",
"start_date": "2022-08-31",
"end_date": null,
"last_charged_on": "2022-09-16",
"last_attempt_at": null,
"last_attempt_by_id": null,
"interval": "1_month",
"day": 28,
"max_additional_times": null,
"total_times_charged": 2,
"amount": 90,
"currency": "USD",
"secret": "bfb9d17fa8a24e02f864b12f5a732177",
"first_name": "Testy",
"last_name": "McTest",
"org_name": null,
"email_address": "test@example.com",
"phone_number": "555-0100",
"street": "123 Test Street",
"city": "Example City",
"state": "XY",
"postal": "00000",
"country": "US",
"last_digits": "4242",
"card_bin": null,
"card_is_international": false,
"card_funding": "credit",
"bank_name": null,
"donation_campaign_id": 1,
"donation_appeal_id": null,
"donation_donate_page_id": null,
"donation_fund_id": 3,
"donation_split_fund_id": null,
"donation_split_fund_amount": 0,
"donation_staff_comment": "virtual terminal recurring test",
"status": "active",
"status_date": "2022-09-16",
"problem_message": null,
"cancel_type": null,
"added_at": "2022-08-31T23:23:05+00:00",
"added_by_id": 10,
"updated_at": "2022-09-16T21:10:53+00:00",
"updated_by_id": 10
},
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Refund Posted
Whenever a refund is posted to someone's account.
{
"id": "794f2a33cff7b3a9158ff9ec5b52476e",
"event": "refund_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"refund": {
"object": "refund",
"id": 6,
"student_id": 1,
"transaction_id": 21,
"number": 1,
"amount": 100,
"online_payment_id": null,
"refund_source": null,
"reference_number": null,
"receipt_number": "ce9sfe5d2e",
"currency": "USD",
"exchange_rate": null,
"home_currency_amount": 100,
"treat_as_aid": false,
"organization_name": null,
"method": "other",
"paid_to_type": "person",
"paid_to_id": 2
},
"sandbox": true
}
}
Role Added/Reactivated
Whenever a role is added to a person or reactivated.
{
"id": "2f803ad5ecd9f37a8f965ded9a0255cf",
"event": "role_added_reactivated",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"role": {
"object": "role",
"id": 7,
"name": "Academic Admin",
"abbrv": "ADMIN"
},
"role_added": true,
"role_reactivated": true,
"sandbox": true
}
}
Role Removed/Inactivated
Whenever a role is removed from a person or inactivated.
{
"id": "2288757f6ef931c971a5b68a7dfeab75",
"event": "role_removed_inactivated",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"role": {
"object": "role",
"id": 7,
"name": "Academic Admin",
"abbrv": "ADMIN"
},
"role_removed": true,
"role_inactivated": true,
"sandbox": true
}
}
Social Feed Followed
Whenever someone follows someone else's personal feed.
{
"id": "8e31f26b3a12f594252ee29431b3ab56",
"event": "social_feed_followed",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"follower": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"followed": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Standardized Test Score Updated
Whenever a standardized test score or section score is added or changed.
{
"id": "330c539320d3a05f417b22ac33c81793",
"event": "standardized_test_score_updated",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"room_plan": {
"object": "room_plan",
"id": 1,
"name": "Palace",
"capacity": true,
"amount": 1250,
"added_at": null,
"added_by_id": null
},
"room": {
"object": "room",
"id": 1,
"building_id": 3,
"name": "Administrative Offices",
"floor": "1",
"capacity": null,
"default_room_plan_id": null,
"retired_at": null,
"retired_by_id": null,
"added_at": null,
"added_by_id": null
},
"building": {
"object": "building",
"id": 1,
"campus_id": 8,
"name": "Example Building",
"street": "5555 Test Avenue",
"city": "Example City",
"state": "XY",
"postal": "00000",
"country": "US",
"floors": 2,
"basement_floors": 1,
"retired_at": null,
"retired_by_id": null,
"added_at": null,
"added_by_id": null
},
"room_plan_student": {
"object": "room_plan_student",
"id": 6,
"term_id": 73,
"student_id": 2388,
"plan_id": 4,
"room_id": null,
"capacity_used": 1,
"added_at": null,
"added_by_id": null
},
"sandbox": true
}
}
Student Course Enrollment Status Changed
Whenever a student's enrollment status in a course changes (e.g. Enrolled to Withdrawn, or the student is added/removed from the course).
{
"id": "2b2323e8a01bd6b9a072bfe8058e65e7",
"event": "course_offering_student_status_updated",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"course": {
"object": "course_offering",
"id": 21908,
"academic_term_id": 4,
"campus_id": null,
"finalized": false,
"finalized_at": null,
"max_enrolled": null,
"max_auditors": null,
"roster_visibility": true,
"start_date": "2022-05-20",
"end_date": "2022-10-08",
"add_drop_time": null,
"published": true,
"open_to_students_date": null,
"closed_to_students_date": null,
"faculty_can_manage_roster": false,
"faculty_can_override_enrollment": false,
"students_can_add_discussions": true,
"disable_student_bulletin_board_posts": false,
"allow_auditor_assignments": false,
"allow_auditor_attendance": false,
"allow_auditor_evaluations": false,
"waiting_list_management": "automatic",
"image_file_id": null,
"show_progress_to_students": false,
"catalog_courses": [
{
"object": "catalog_course",
"id": 1,
"course_offering_id": 21908,
"catalog_course_id": 688,
"primary": true,
"abbrv": "LAT101",
"name": "Beginning Latin I",
"description": null,
"section": "1",
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"affects_standing": true,
"affects_full_time_status": true,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"fulfills_program_requirements": true,
"minimum_attendance": null,
"hide_self_register": false,
"self_enroll": "yes",
"self_audit": true,
"delivery_methods": [
{
"object": "course_delivery_method",
"id": 5,
"name": "Hybrid Online",
"distance_education": false,
"status": "active",
"primary": 1,
"added_at": null,
"added_by_id": null
}
],
"added_at": null,
"added_by_id": null
}
]
},
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"enrollment": {
"object": "enrollment",
"id": 6000000,
"course_offering_id": 21908,
"catalog_course_id": 688,
"student_id": 16,
"status": "enrolled",
"status_expires_at": null,
"pending_reason": null,
"final_comment": null,
"final_grade": 91.5,
"final_attendance": 0,
"released_final_grade": null,
"commented_by_id": null,
"enrolled_by_id": null,
"enrolled_by_type": "registrar",
"status_date": "2022-10-05",
"enrolled_date": null,
"credits": 2,
"hours": 2,
"attendance_hours": null,
"clinical_hours": null,
"pass_fail": false,
"finalized": false,
"finalized_at": null,
"delivery_method_id": null,
"automatically_removed_at": null,
"automatically_removed_from": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"display_status": "Enrolled"
},
"sandbox": true
}
}
Student Degree Added
Whenever a degree is added to a student.
{
"id": "e5987ca9aefab47b502035aacd67b951",
"event": "student_degree_added",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"program": {
"object": "program",
"id": 2,
"name": "Certificate",
"units": "credits",
"graduate_level": false,
"default": 1,
"default_tuition_schedule_id": null,
"default_enrollment_agreement_page_layout_id": null,
"grants_academic_credit": true,
"standings_include_clinical_hours": false,
"continuous_enrollment": false,
"payment_period_behavior": "none",
"payment_period_default_length": null,
"payment_period_max_length": null,
"payment_period_max_units": null,
"hidden_from_students": false,
"external_id": "C1",
"status": "active"
},
"degree": {
"object": "degree",
"id": 1,
"program_id": 1,
"degree_level_id": 4,
"department_id": 1,
"name": "Bachelor of Arts Degree in Liberal Arts and Culture",
"description": "Bachelor of Arts Degree in Liberal Arts and Culture",
"abbrv": "BA_LAC",
"diploma": true,
"status": "active",
"cip_code": "24.0101",
"unit": "credits",
"distance_education": false,
"length": 4,
"length_unit": "years",
"external_id": null
},
"student_degree": {
"object": "student_degree",
"id": 1,
"student_id": 1,
"degree_id": 1,
"status": "active",
"graduation_date": null,
"active_date": "2006-08-18",
"inactive_date": null,
"catalog_year_id": 1,
"anticipated_completion_date": null,
"show_on_transcript": true
},
"sandbox": true
}
}
Student Degree Removed
Whenever a degree is removed from a student.
{
"id": "2358fb00b1481d3ec6b8059520dc4878",
"event": "student_degree_removed",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"program": {
"object": "program",
"id": 2,
"name": "Certificate",
"units": "credits",
"graduate_level": false,
"default": 1,
"default_tuition_schedule_id": null,
"default_enrollment_agreement_page_layout_id": null,
"grants_academic_credit": true,
"standings_include_clinical_hours": false,
"continuous_enrollment": false,
"payment_period_behavior": "none",
"payment_period_default_length": null,
"payment_period_max_length": null,
"payment_period_max_units": null,
"hidden_from_students": false,
"external_id": "C1",
"status": "active"
},
"degree": {
"object": "degree",
"id": 1,
"program_id": 1,
"degree_level_id": 4,
"department_id": 1,
"name": "Bachelor of Arts Degree in Liberal Arts and Culture",
"description": "Bachelor of Arts Degree in Liberal Arts and Culture",
"abbrv": "BA_LAC",
"diploma": true,
"status": "active",
"cip_code": "24.0101",
"unit": "credits",
"distance_education": false,
"length": 4,
"length_unit": "years",
"external_id": null
},
"student_degree": {
"object": "student_degree",
"id": 1,
"student_id": 1,
"degree_id": 1,
"status": "active",
"graduation_date": null,
"active_date": "2006-08-18",
"inactive_date": null,
"catalog_year_id": 1,
"anticipated_completion_date": null,
"show_on_transcript": true
},
"sandbox": true
}
}
Student Degree Updated
Whenever a student's degree is changed.
{
"id": "474189c84f7b5ab2f787f0f10fcaf3ba",
"event": "student_degree_updated",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"program": {
"object": "program",
"id": 2,
"name": "Certificate",
"units": "credits",
"graduate_level": false,
"default": 1,
"default_tuition_schedule_id": null,
"default_enrollment_agreement_page_layout_id": null,
"grants_academic_credit": true,
"standings_include_clinical_hours": false,
"continuous_enrollment": false,
"payment_period_behavior": "none",
"payment_period_default_length": null,
"payment_period_max_length": null,
"payment_period_max_units": null,
"hidden_from_students": false,
"external_id": "C1",
"status": "active"
},
"degree": {
"object": "degree",
"id": 1,
"program_id": 1,
"degree_level_id": 4,
"department_id": 1,
"name": "Bachelor of Arts Degree in Liberal Arts and Culture",
"description": "Bachelor of Arts Degree in Liberal Arts and Culture",
"abbrv": "BA_LAC",
"diploma": true,
"status": "active",
"cip_code": "24.0101",
"unit": "credits",
"distance_education": false,
"length": 4,
"length_unit": "years",
"external_id": null
},
"student_degree": {
"object": "student_degree",
"id": 1,
"student_id": 1,
"degree_id": 1,
"status": "active",
"graduation_date": null,
"active_date": "2006-08-18",
"inactive_date": null,
"catalog_year_id": 1,
"anticipated_completion_date": null,
"show_on_transcript": true
},
"affected_data": [
{
"object": "student_degree_updated_affected_data",
"id": 29,
"model_type_id": 129,
"type": "DEGREE_ANTICIPATED_COMPLETION_DATE"
}
],
"sandbox": true
}
}
Student Program Added
Whenever a program is added to a student.
{
"id": "5cb5e264f0efe4c4a32409961ba29489",
"event": "student_program_added",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student_program": {
"object": "student_program",
"id": 5,
"student_id": 12,
"program_id": 2,
"started_on": "2004-10-20",
"entrance_term_id": null,
"exit_date": null,
"exit_reason_id": null,
"education_level_id": null,
"enrollment_status": "automatic",
"first_time": false,
"most_recent": true,
"transfer_student": false,
"name": "Certificate",
"units": "credits",
"added_at": null,
"added_by_id": null
},
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"program": {
"object": "program",
"id": 2,
"name": "Certificate",
"units": "credits",
"graduate_level": false,
"default": 1,
"default_tuition_schedule_id": null,
"default_enrollment_agreement_page_layout_id": null,
"grants_academic_credit": true,
"standings_include_clinical_hours": false,
"continuous_enrollment": false,
"payment_period_behavior": "none",
"payment_period_default_length": null,
"payment_period_max_length": null,
"payment_period_max_units": null,
"hidden_from_students": false,
"external_id": "C1",
"status": "active"
},
"sandbox": true
}
}
Student Program Removed
Whenever a program is removed from a student.
{
"id": "84e5b733463936037006dee4743652ba",
"event": "student_program_removed",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student_program": {
"object": "student_program",
"id": 5,
"student_id": 12,
"program_id": 2,
"started_on": "2004-10-20",
"entrance_term_id": null,
"exit_date": null,
"exit_reason_id": null,
"education_level_id": null,
"enrollment_status": "automatic",
"first_time": false,
"most_recent": true,
"transfer_student": false,
"name": "Certificate",
"units": "credits",
"added_at": null,
"added_by_id": null
},
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"program": {
"object": "program",
"id": 2,
"name": "Certificate",
"units": "credits",
"graduate_level": false,
"default": 1,
"default_tuition_schedule_id": null,
"default_enrollment_agreement_page_layout_id": null,
"grants_academic_credit": true,
"standings_include_clinical_hours": false,
"continuous_enrollment": false,
"payment_period_behavior": "none",
"payment_period_default_length": null,
"payment_period_max_length": null,
"payment_period_max_units": null,
"hidden_from_students": false,
"external_id": "C1",
"status": "active"
},
"sandbox": true
}
}
Student Program Updated
Whenever a student's program is changed.
{
"id": "a67b1865afb0a3723aa860c64bcddafd",
"event": "student_program_updated",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"program": {
"object": "program",
"id": 2,
"name": "Certificate",
"units": "credits",
"graduate_level": false,
"default": 1,
"default_tuition_schedule_id": null,
"default_enrollment_agreement_page_layout_id": null,
"grants_academic_credit": true,
"standings_include_clinical_hours": false,
"continuous_enrollment": false,
"payment_period_behavior": "none",
"payment_period_default_length": null,
"payment_period_max_length": null,
"payment_period_max_units": null,
"hidden_from_students": false,
"external_id": "C1",
"status": "active"
},
"student_program": {
"object": "student_program",
"id": 5,
"student_id": 12,
"program_id": 2,
"started_on": "2004-10-20",
"entrance_term_id": null,
"exit_date": null,
"exit_reason_id": null,
"education_level_id": null,
"enrollment_status": "automatic",
"first_time": false,
"most_recent": true,
"transfer_student": false,
"name": "Certificate",
"units": "credits",
"added_at": null,
"added_by_id": null
},
"affected_data": [
{
"object": "student_program_updated_affected_data",
"id": 23,
"model_type_id": 118,
"type": "PROGRAM_EXIT_REASON"
}
],
"sandbox": true
}
}
Tag Added to Organization
Whenever a tag is added to an organization.
{
"id": "070ffff46d0f9c4caf8f05dcfe888a6f",
"event": "tag_added_to_contact_organization",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"sandbox": true
}
}
Tag Added to Person
Whenever a tag is added to a person.
{
"id": "faddc0864095bc108920d10033b36c85",
"event": "tag_added_to_person",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"tag": {
"object": "tag",
"id": 500,
"name": "Active Lead",
"autogenerated": 1,
"added_at": null,
"added_by_id": null
},
"sandbox": true
}
}
Tag Removed from Organization
Whenever a tag is removed from an organization.
{
"id": "f85e3037c5fd1641fba20429028444f8",
"event": "tag_removed_from_contact_organization",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"to_do": {
"object": "todo",
"id": 8,
"name": "Print new brocures",
"assigned_to": 1,
"assigned_by_id": 1,
"attached_to": null,
"completed_by_id": 1,
"due_date": "2019-07-02",
"completed_time": null,
"added_time": "2019-06-26T00:57:21+00:00",
"communication_plan_id": null
},
"sandbox": true
}
}
Tag Removed from Person
Whenever a tag is removed from a person.
{
"id": "6a003d0a05e71a88ad7145cc346550a5",
"event": "tag_removed_from_person",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"tag": {
"object": "tag",
"id": 500,
"name": "Active Lead",
"autogenerated": 1,
"added_at": null,
"added_by_id": null
},
"sandbox": true
}
}
Test Submitted
Whenever a student submits a test.
{
"id": "21165f3190591d8f8c040e836601a90f",
"event": "assignment_test_submitted",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"form": {
"object": "form",
"id": 1,
"current_version_id": 1,
"type": "form",
"name": "Form",
"description": null,
"image_file_id": null,
"published": true,
"accept_responses": true,
"available_from": null,
"available_until": null,
"self_service": false,
"require_user": false,
"require_request": false,
"anonymous_responses": false,
"can_choose_linked_model": false,
"user_response_limit": null,
"total_response_limit": null,
"response_review": "review",
"enable_sms_verification": false,
"redirect_url": null,
"thank_you_message": null,
"custom_css": null,
"fee_id": null,
"fee_amount": null,
"can_charge_to_account": false,
"default_localization_id": null,
"retired_by_id": null,
"retired_at": null,
"added_at": null,
"added_by_id": null
},
"response": {
"object": "form_response",
"id": 1,
"form_id": 1,
"form_version_id": 1,
"form_response_batch_id": null,
"person_id": 10,
"first_name": null,
"last_name": null,
"email": null,
"review": "review",
"status": "submitted",
"needs_review": null,
"needs_resubmit": null,
"fee_id": null,
"fee_amount": null,
"fee_discount": null,
"can_charge_to_account": false,
"fee_status": "unpaid",
"charge_method": null,
"sales_receipt_id": null,
"started_at": "2022-07-13T23:07:51+00:00",
"submitted_at": "2022-07-13T23:08:31+00:00",
"decision_by_id": null,
"decision_at": null,
"localization_id": null,
"requested_by_id": null,
"requested_at": null,
"added_at": "2022-07-13T23:07:51+00:00",
"respondent_url": "https:\/\/yourschool.populiweb.com\/router\/forms\/respond\/g795538da7a2293a0f77a7a697b178cc281eaf34e1c8ac6c5b784920d90c6944c03ac9ff54c31fc4b06ac3952ebc36969975080cc106f69f060ccb76abb9"
},
"sandbox": true
}
}
To-do Assigned
Whenever a to-do is assigned to someone.
{
"id": "7b9102e2b27da7e144f232c24edac8f6",
"event": "to_do_assigned",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"to_do": {
"object": "todo",
"id": 8,
"name": "Print new brocures",
"assigned_to": 1,
"assigned_by_id": 1,
"attached_to": null,
"completed_by_id": 1,
"due_date": "2019-07-02",
"completed_time": null,
"added_time": "2019-06-26T00:57:21+00:00",
"communication_plan_id": null
},
"sandbox": true
}
}
To-do Completed
Whenever a to-do is completed.
{
"id": "57e6ddce7f6a6ac4f470261d0d72c4cb",
"event": "to_do_completed",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"course": {
"object": "course_offering",
"id": 21908,
"academic_term_id": 4,
"campus_id": null,
"finalized": false,
"finalized_at": null,
"max_enrolled": null,
"max_auditors": null,
"roster_visibility": true,
"start_date": "2022-05-20",
"end_date": "2022-10-08",
"add_drop_time": null,
"published": true,
"open_to_students_date": null,
"closed_to_students_date": null,
"faculty_can_manage_roster": false,
"faculty_can_override_enrollment": false,
"students_can_add_discussions": true,
"disable_student_bulletin_board_posts": false,
"allow_auditor_assignments": false,
"allow_auditor_attendance": false,
"allow_auditor_evaluations": false,
"waiting_list_management": "automatic",
"image_file_id": null,
"show_progress_to_students": false,
"catalog_courses": [
{
"object": "catalog_course",
"id": 1,
"course_offering_id": 21908,
"catalog_course_id": 688,
"primary": true,
"abbrv": "LAT101",
"name": "Beginning Latin I",
"description": null,
"section": "1",
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"affects_standing": true,
"affects_full_time_status": true,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"fulfills_program_requirements": true,
"minimum_attendance": null,
"hide_self_register": false,
"self_enroll": "yes",
"self_audit": true,
"delivery_methods": [
{
"object": "course_delivery_method",
"id": 5,
"name": "Hybrid Online",
"distance_education": false,
"status": "active",
"primary": 1,
"added_at": null,
"added_by_id": null
}
],
"added_at": null,
"added_by_id": null
}
]
},
"assignment": {
"object": "assignment",
"id": 29656,
"course_offering_id": 21908,
"name": "Midterm Test",
"points": 100,
"due_at": null,
"available_from": null,
"available_until": null,
"published": true,
"description": "This is a test",
"assignment_group_id": null,
"lesson_id": null,
"type": "test",
"allowed_file_types": null,
"visible_to_students_before_available": true,
"extra_credit": false,
"pass_fail": false,
"mandatory_pass": false,
"peer_review": false,
"anonymous_reviews": true,
"submission_visibility": "always",
"randomize_submissions": false,
"review_visibility": "never",
"allow_review_comments": false,
"peer_grade": false,
"grade_submissions": null,
"grade_reviews": null,
"reviews_due_at": null,
"reviews_closed_at": null,
"auto_check_submissions_for_plagiarism": false,
"plagiarism_checks_visible_to_students": false,
"plagiarism_check_provider": null,
"release_grades": "yes",
"release_grades_at": null,
"added_at": null,
"added_by_id": null
},
"assignment_submission": {
"object": "assignment_submission",
"id": 6,
"assignment_id": 24668,
"student_id": 2921,
"comment": "comment #5",
"content": "blah blah",
"file_id": null,
"student_visibility": "visible",
"draft": false,
"student_submission": false,
"assignment_time_due": null,
"plagiarism_checks_visible_to_student": false,
"added_at": "2011-07-21T21:45:16+00:00",
"added_by_id": 2921,
"updated_at": null,
"updated_by_id": null,
"deleted_at": null,
"deleted_by_id": null
},
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Transcript Request Created
Whenever a new transcript request is made
Example payload currently unavailable for this event.
Transfer Credit Approved
Whenever a transfer credit is approved.
{
"id": "5f5dde04905fe81cade3505c5b76ba4c",
"event": "transfer_credit_approved",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"transfer_credit": {
"object": "transfer_credit",
"id": 1,
"person_id": 1,
"transfer_institution_id": 1,
"description": "Spanish 1",
"credits": 2,
"hours": null,
"attendance_hours": null,
"clinical_hours": null,
"fulfills_program_requirements": true,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"affects_standing": true,
"course_number": "SPAN101",
"course_name": "Spanish 1",
"applied_date": null,
"effective_date": null,
"course_group_id": null,
"catalog_course_id": 687,
"status": "approved",
"status_at": null,
"status_by_id": null,
"organization_id": 1,
"organization_name": "The Oxford School",
"added_at": null,
"added_by_id": null,
"updated_at": null,
"updated_by_id": null
},
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Ungraded Test Questions
Whenever a course has ungraded test questions.
{
"id": "4b8f40daa6b00665d24008a430700694",
"event": "ungraded_test_questions",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"course": {
"object": "course_offering",
"id": 21908,
"academic_term_id": 4,
"campus_id": null,
"finalized": false,
"finalized_at": null,
"max_enrolled": null,
"max_auditors": null,
"roster_visibility": true,
"start_date": "2022-05-20",
"end_date": "2022-10-08",
"add_drop_time": null,
"published": true,
"open_to_students_date": null,
"closed_to_students_date": null,
"faculty_can_manage_roster": false,
"faculty_can_override_enrollment": false,
"students_can_add_discussions": true,
"disable_student_bulletin_board_posts": false,
"allow_auditor_assignments": false,
"allow_auditor_attendance": false,
"allow_auditor_evaluations": false,
"waiting_list_management": "automatic",
"image_file_id": null,
"show_progress_to_students": false,
"catalog_courses": [
{
"object": "catalog_course",
"id": 1,
"course_offering_id": 21908,
"catalog_course_id": 688,
"primary": true,
"abbrv": "LAT101",
"name": "Beginning Latin I",
"description": null,
"section": "1",
"credits": 2,
"hours": 2,
"attendance_hours": 0,
"clinical_hours": 0,
"affects_standing": true,
"affects_full_time_status": true,
"pass_fail": false,
"pass_affects_gpa": true,
"fail_affects_gpa": true,
"pass_fail_pass_affects_gpa": true,
"pass_fail_fail_affects_gpa": true,
"fulfills_program_requirements": true,
"minimum_attendance": null,
"hide_self_register": false,
"self_enroll": "yes",
"self_audit": true,
"delivery_methods": [
{
"object": "course_delivery_method",
"id": 5,
"name": "Hybrid Online",
"distance_education": false,
"status": "active",
"primary": 1,
"added_at": null,
"added_by_id": null
}
],
"added_at": null,
"added_by_id": null
}
]
},
"sandbox": true
}
}
User Account Added
Whenever a user account is created for a person.
{
"id": "9b6c9273b65bc00806e30a96950056e0",
"event": "user_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"user": {
"object": "user",
"id": 16,
"username": "academic.admin",
"organization_domain_id": null,
"is_active": true,
"blocked_reason": "",
"last_activity_at": null,
"login_type": "ALL"
},
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
User Account Deleted
Whenever a user account is deleted.
{
"id": "41756dde787ab46b4fce66da33404588",
"event": "user_deleted",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"user": {
"object": "user",
"id": 16,
"username": "academic.admin",
"organization_domain_id": null,
"is_active": true,
"blocked_reason": "",
"last_activity_at": null,
"login_type": "ALL"
},
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
User Blocked
Whenever a user is blocked.
{
"id": "75cfa1efbb198af0703f2c4963643304",
"event": "user_blocked",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"user": {
"object": "user",
"id": 16,
"username": "academic.admin",
"organization_domain_id": null,
"is_active": true,
"blocked_reason": "",
"last_activity_at": null,
"login_type": "ALL"
},
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
User Login
Whenever a user logs into Populi.
{
"id": "eb12d713666460781f48921947027748",
"event": "login",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"login": {
"object": "login",
"id": 1,
"user_id": 33,
"username": null,
"outcome": "success",
"is_partial": false,
"server_ip": "102.18.0.7",
"user_ip": "102.18.0.13",
"time": "2024-07-23T21:32:23+00:00",
"browser": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/126.0.0.0 Safari\/537.36",
"browser_fingerprint": 3553873836,
"type": "username_password",
"device_id": 6,
"user_device_id": 1,
"fail_reason": null,
"partial_login_reason": null,
"timezone": "America\/Los_Angeles"
},
"user": {
"object": "user",
"id": 16,
"username": "academic.admin",
"organization_domain_id": null,
"is_active": true,
"blocked_reason": "",
"last_activity_at": null,
"login_type": "ALL"
},
"user_device": {
"object": "user_device",
"id": 1,
"user_id": 33,
"device_id": 6,
"trusted": false,
"is_public": false,
"two_factor_verified_at": null,
"name": null,
"salt": null,
"hashed_token": null,
"token_valid_until": "2024-07-23T00:38:31+00:00",
"last_activity_at": "2024-07-22T23:38:31+00:00",
"added_at": "2024-07-22T23:38:31+00:00",
"added_by_id": 9073141
},
"person": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}
Violation Added
Whenever a campus life violation is added.
{
"id": "ae66f4c4705fa305a43762af94437cf5",
"event": "violation_created",
"created_at": "2026-09-29T23:27:58+00:00",
"test_mode": true,
"sandbox": true,
"api_version": "2026-07-13",
"data": {
"violation": {
"object": "student_violation",
"id": 1,
"student_id": 12,
"violation_id": 1,
"description": "Curfew Violation, after midnight",
"pending_charge_id": null,
"added_on": "2022-07-19",
"added_at": "2022-07-19T16:19:56+00:00",
"added_by_id": 10
},
"student": {
"object": "person",
"id": 1,
"first_name": "Elizabeth",
"last_name": "Fox",
"middle_name": null,
"prefix": "Miss",
"suffix": null,
"preferred_name": null,
"display_name": "Elizabeth Fox",
"salutation": "Miss Elizabeth Fox",
"addressee": "Miss Elizabeth Fox",
"gender": "female",
"other_gender": null,
"image_file_id": null,
"birth_date": null,
"status": "active",
"social_security_number": null,
"alien_registration_number": null,
"social_insurance_number": null,
"home_city": null,
"home_state": null,
"home_country": null,
"former_name": null,
"license_plate": null,
"bio": null,
"hispanic_latino": false,
"resident_alien": false,
"localization_id": null,
"notification_email_id": null,
"deceased_date": null,
"import_id": null,
"staff_id": null,
"faculty_id": null,
"degree_level_id": null,
"added_at": null,
"added_by_id": null,
"updated_at": null,
"private_profile": false,
"is_user": true
},
"sandbox": true
}
}