Name: OpenEMIS Core
Article Name: Webhooks
Category/Module: Administration
Tags: SSO, Webhooks, Manage
Version: 3.9.6.2
Date Updated: 13 July 2017
Article Name: Webhooks
Category/Module: Administration
Tags: SSO, Webhooks, Manage
Version: 3.9.6.2
Date Updated: 13 July 2017
Webhooks are user defined HTTP callbacks associated with an event triggered by the current system which can then invoke a behaviour on another system. E.g. The Administrator will have the flexibility if they would like to configure the system such that OpenEMIS Dashboard will logout itself whenever OpenEMIS Core is logged out.
To achieve this, the administrator will go to OpenEMIS Core to add a webhook to react on the Logout event of OpenEMIS Core.
Webhooks Configuration
1) Go to OpenEMIS Core
2) Go Administration > System Setup > System Configurations
3) Select Webhooks from dropdown list
4) Select Add button
5) Enter the Required fields (such as Name, URL, Status, Method and Triggered Event).
6) Select Save. System will display a successful message.
7) Please see the following table for different Webhooks scenarios:
| Webhook | Format/Fields | Example |
|---|---|---|
| Logout |
|
{username: admin} |
| Institution Create |
|
{ “institution_id”: 43, “institution_name”: “Bluesky Primary School”, “institution_alternative_name”: “BPS”, “institution_code”: “BPS01”, “institution_classification”: “Academic Institution”, “institution_sector”: “Public”, “institution_type”: “Primary”, “institution_gender”: “Mixed”, “institution_date_opened”: “26-06-1984”, “institution_address”: “100 Over The Blue Horizon Avenue, Moonlight”, “institution_postal_code”: “1000000”, “institution_locality”: “Rural”, “institution_latitude”: “24.678”, “institution_longitude”: “15.678”, “institution_area_education”: “District 1”, “institution_area_administrative”: “District 2”, “institution_contact_person”: “Joshua Plain”, “institution_telephone”: “098 3456787”, “institution_mobile”: “097 4567875”, “institution_email”: “joshuaplain@gmail.com”, “institution_website”: “blueksyprimaryschool.com” } |
| Institution Update |
|
{ “institution_id”: 43, “institution_name”: “Bluesky Primary School”, “institution_alternative_name”: “BPS”, “institution_code”: “BPS01”, “institution_classification”: “Academic Institution”, “institution_sector”: “Public”, “institution_type”: “Primary”, “institution_gender”: “Mixed”, “institution_date_opened”: “26-06-1984”, “institution_address”: “100 Over The Blue Horizon Avenue, Moonlight”, “institution_postal_code”: “1000000”, “institution_locality”: “Rural”, “institution_latitude”: “24.678”, “institution_longitude”: “15.678”, “institution_area_education”: “District 1”, “institution_area_administrative”: “District 2”, “institution_contact_person”: “Mary Jane Thien”, “institution_telephone”: “098 3456787”, “institution_mobile”: “097 4567875”, “institution_email”: “maryjanethien@gmail.com”, “institution_website”: “blueksyprimaryschool.com” } |
| Institution Delete |
|
{ “institution_id”: 49 } |
| Class Create |
|
{ “institutions_id”: 6, “institutions_name”: “Avory Primary School”, “institutions_code”: “P1002”, “institutions_classes_id”: 496, “institutions_classes_name”: “Primary 1-A”, “academic_periods_name”: “2020”, “shift_options_name”: “First Shift”, “institutions_classes_capacity”: 50, “education_grades_name”: [ “Primary 1” ], “institution_classes_total_male_students”: 13, “institution_classes_total_female_studentss”: 26, “total_students”: 39, “institution_classes_staff_openemis_no”: “1522952436”, “institution_classes_secondary_staff_openemis_no”: [ “1522277253”, “1522952430” ], “institution_class_students_openemis_no”: [ “1548404852”, “1548404854”, “1548404855”, “1548404858”, “1548404860”, “1548404864”, “1548404867”, “1548404869”, “1548404871”, “1548404878”, “1548404880”, “1600663446”, “1600663471”, “1548404845”, “1548404846”, “1548404847”, “1548404848”, “1548404849”, “1548404850”, “1548404851”, “1548404853”, “1548404856”, “1548404857”, “1548404859”, “1548404861”, “1548404862”, “1548404863”, “1548404865”, “1548404868”, “1548404870”, “1548404872”, “1548404873”, “1548404874”, “1548404875”, “1548404876”, “1548404877”, “1548404879”, “1548404881”, “1600663453” ] } |
| Class Update |
|
{ “institutions_id”: 6, “institutions_name”: “Avory Primary School”, “institutions_code”: “P1002”, “institutions_classes_id”: 496, “institutions_classes_name”: “Primary 1-A”, “academic_periods_name”: “2020”, “shift_options_name”: “First Shift”, “institutions_classes_capacity”: 40, “education_grades_name”: [ “Primary 1” ], “institution_classes_total_male_students”: 13, “institution_classes_total_female_studentss”: 26, “total_students”: 39, “institution_classes_staff_openemis_no”: “1522952436”, “institution_classes_secondary_staff_openemis_no”: [ “1522277253”, “1522952430” ], “institution_class_students_openemis_no”: [ “1548404852”, “1548404854”, “1548404855”, “1548404858”, “1548404860”, “1548404864”, “1548404867”, “1548404869”, “1548404871”, “1548404878”, “1548404880”, “1600663446”, “1600663471”, “1548404845”, “1548404846”, “1548404847”, “1548404848”, “1548404849”, “1548404850”, “1548404851”, “1548404853”, “1548404856”, “1548404857”, “1548404859”, “1548404861”, “1548404862”, “1548404863”, “1548404865”, “1548404868”, “1548404870”, “1548404872”, “1548404873”, “1548404874”, “1548404875”, “1548404876”, “1548404877”, “1548404879”, “1548404881”, “1600663453” ] } |
| Class Delete |
|
{ “institution_classes_id”: “29” } |
| Subject Create |
|
{ “education_systems_name”: “National Education System”, “education_levels_name”: “Primary Education”, “education_cycles_name”: “Primary – General”, “education_programmes_code”: “Primary”, “education_programmes_name”: “Primary”, “education_grades_code”: “Primary 1”, “education_grades_name”: “Primary 1”, “education_subjects_code”: “SSMC”, “education_subjects_name”: “Social Studies”, “institutions_id”: 43, “institutions_code”: “BPS01”, “institutions_name”: “Bluesky Primary School”, “institution_classes_name”: “Primary 1-B”, “academic_periods_code”: “YR2020”, “academic_periods_name”: “2020”, “institution_subjects_id”: 4389, “institution_subjects_name”: “Social Studies”, “security_users_openemis_no_subject_teachers”: null, “security_users_openemis_no_students”: null } |
| Subject Update |
|
{ “education_systems_name”: “National Education System”, “education_levels_name”: “Primary Education”, “education_cycles_name”: “Primary – General”, “education_programmes_code”: “Primary”, “education_programmes_name”: “Primary”, “education_grades_code”: “Primary 1”, “education_grades_name”: “Primary 1”, “education_subjects_code”: “SSMC”, “education_subjects_name”: “Social Studies”, “institutions_id”: 43, “institutions_code”: “BPS01”, “institutions_name”: “Bluesky Primary School”, “institution_classes_name”: “Primary 1-B”, “academic_periods_code”: “YR2020”, “academic_periods_name”: “2020”, “institution_subjects_id”: 4389, “institution_subjects_name”: “Social Studies”, “security_users_openemis_no_subject_teachers”: 1522277253, “security_users_openemis_no_students”: null } |
| Subject Delete |
|
{ “institution_subjects_id”: null } |
| Student Create |
|
{ “security_users_id”: 1154, “security_users_openemis_no”: “1522412919”, “security_users_first_name”: “Stephanie”, “security_users_middle_name”: null, “security_users_third_name”: null, “security_users_last_name”: “Patti”, “security_users_preferred_name”: null, “security_users_gender”: “Female”, “security_users_date_of_birth”: “07-10-2020”, “security_users_address”: null, “security_users_postal_code”: null, “area_administrative_name_birthplace”: null, “area_administrative_name_address”: null, “contact_type_name”: null, “user_contact_type_value”: null, “nationality_name”: null, “identity_type_name”: null, “user_identities_number”: null, “security_user_username”: “1522412919”, “institutions_id”: 6, “institutions_code”: “P1002”, “institutions_name”: “Avory Primary School”, “academic_period_code”: “YR2019”, “academic_period_name”: “2019”, “education_grade_name”: “Primary 3”, “student_status_name”: “Promoted”, “institution_students_start_date”: “07-10-2020”, “institution_students_end_date”: “07-10-2020” } |
| Student Update |
|
{ “security_users_id”: 1154, “security_users_openemis_no”: “1522412919”, “security_users_first_name”: “Stephanie”, “security_users_middle_name”: “Maurren”, “security_users_third_name”: null, “security_users_last_name”: “Patti”, “security_users_preferred_name”: null, “security_users_gender”: “Female”, “security_users_date_of_birth”: “07-10-2020”, “security_users_address”: null, “security_users_postal_code”: null, “area_administrative_name_birthplace”: null, “area_administrative_name_address”: null, “contact_type_name”: null, “user_contact_type_value”: null, “nationality_name”: null, “identity_type_name”: null, “user_identities_number”: null, “security_user_username”: “1522412919”, “institutions_id”: 6, “institutions_code”: “P1002”, “institutions_name”: “Avory Primary School”, “academic_period_code”: “YR2019”, “academic_period_name”: “2019”, “education_grade_name”: “Primary 3”, “student_status_name”: “Promoted”, “institution_students_start_date”: “07-10-2020”, “institution_students_end_date”: “07-10-2020” } |
| Student Delete |
|
{ “institution_student_id”: “30” } |
| Staff Create |
|
{ “security_users_id”: 12003, “security_users_openemis_no”: “1602836845”, “security_users_first_name”: “Tony”, “security_users_middle_name”: “Blazing”, “security_users_third_name”: “Hot”, “security_users_last_name”: “Hawk”, “security_users_preferred_name”: “Tony”, “security_users_gender”: “Male”, “security_users_date_of_birth”: “12-06-1980”, “security_users_address”: “131 Parkway Lane”, “security_users_postal_code”: “123456”, “area_administrative_name_birthplace”: “District 1”, “area_administrative_name_address”: “District 1”, “contact_type_name”: null, “user_contact_type_value”: null, “nationality_name”: “American”, “identity_type_name”: null, “user_identities_number”: null, “security_user_username”: “1602836845”, “institutions_id”: 25, “institutions_code”: “001”, “institutions_name”: “Asocial Primary School”, “institution_staff_id”: 467, “institution_staff_start_date”: “01-01-2020”, “institution_staff_end_date”: null, “institution_positions_position_no”: “001-1602836775”, “staff_position_titles_type”: “Teaching”, “staff_position_titles_name”: “Teacher”, “staff_types_name”: “Permanent”, “shift_options_name”: null } |
| Staff Update |
|
{ “security_users_id”: 12003, “security_users_openemis_no”: “1602836845”, “security_users_first_name”: “Tony”, “security_users_middle_name”: “Blazing”, “security_users_third_name”: “Hot”, “security_users_last_name”: “Hawk”, “security_users_preferred_name”: “Tony”, “security_users_gender”: “Male”, “security_users_date_of_birth”: “12-06-1980”, “security_users_address”: “131 Parkway Lane”, “security_users_postal_code”: “123456”, “area_administrative_name_birthplace”: “District 1”, “area_administrative_name_address”: “District 1”, “contact_type_name”: null, “user_contact_type_value”: null, “nationality_name”: “American”, “identity_type_name”: null, “user_identities_number”: null, “security_user_username”: “1602836845”, “institutions_id”: 25, “institutions_code”: “001”, “institutions_name”: “Asocial Primary School”, “institution_staff_id”: 467, “institution_staff_start_date”: “01-01-2020”, “institution_staff_end_date”: null, “institution_positions_position_no”: “001-1602836775”, “staff_position_titles_type”: “Teaching”, “staff_position_titles_name”: “Teacher”, “staff_types_name”: “Permanent”, “shift_options_name”: null } |
| Staff Delete |
|
{ “institution_staff_id”: “21” } |
| Programme Create |
|
{
“education_system_name”: “National Education System”, “education_level_name”: “Primary Education”, “education_cycle_name”: “Primary – General”, “education_programme_code”: “Primary”, “education_programme_name”: “Primary”, “institution_id”: 25, “institution_name”: “Asocial Primary School”, “institution_code”: “001”, “institution_grade_id”: 104, “institution_programme_grade_subjects_id”: [ 137, 138, 139, 140, 141, 142, 143, 144 ], “institution_subject_name”: [ “SSMC – Social Studies”, “EA – Expressive Arts”, “PE – Physical Education”, “CA – Creative Arts”, “MA – Mathematics”, “SP – Spanish”, “AD – Artistic Design”, “SCI – Science” ], “start_date”: “16-10-2020” } |
| Programme Update |
|
{
“education_system_name”: “National Education System”, “education_level_name”: “Primary Education”, “education_cycle_name”: “Primary – General”, “education_programme_code”: “Primary”, “education_programme_name”: “Primary”, “institution_id”: 25, “institution_name”: “Asocial Primary School”, “institution_code”: “001”, “institution_grade_id”: 104, “institution_programme_grade_subjects_id”: [ 137, 138, 139, 140, 141, 142, 143, 144 ], “institution_subject_name”: [ “SSMC – Social Studies”, “EA – Expressive Arts”, “PE – Physical Education”, “CA – Creative Arts”, “MA – Mathematics”, “SP – Spanish”, “AD – Artistic Design”, “SCI – Science” ], “start_date”: “16-10-2020” } |
| Programme Delete |
|
{ “institution_grades_id”: 106 } |
