Overview
Webhooks can be configured for Avela organizations who like to be notified of key changes during the application or enrollment workflow. You can configure one webhook with multiple events or create a different webhook for each distinct event.
Webhook events
Parent/Guardian Events
- Parent/Guardian Created
- Parent/Guardian Updated
Student Events
- Student Created
- Student Updated
Form status or substatus change
- Submitted
- Verified
- Lottery Ready
- Canceled
- Deleted
- Admissions
- Offered
- Offer Accepted
- Offer Declined
- Offer Revoked
- Waitlisted
- Waitlist Withdrawn
- Waitlist Removed
Webhook sample payloads
Student update
{
"created_at": "2024-01-11T01:42:45.369083+00:00",
"deleted_at": null,
"entity_id": "6bb39dcd-820b-4d75-98f6-d5604d5abcec",
"entity_type": "PERSON",
"id": "5f6ba287-9cbf-4b04-a301-a560eec400dd",
"name": "STUDENT_UPDATED",
"new_values": {
"active": true,
"avatar": "",
"birth_date": "1997-02-20",
"city": "Los Angeles",
"created_at": "2023-01-17T18:14:15.755276+00:00",
"deleted_at": null,
"email_address": null,
"email_okay": false,
"first_name": "Student",
"id": "6bb39dcd-820b-4d75-98f6-d5604d5abcec",
"last_name": "Student",
"middle_name": "Student",
"phone_number": null,
"preferred_language": null,
"reference_id": "",
"sms_okay": false,
"state": "CA",
"street_address": "532 S Olive St",
"street_address_line_2": "",
"updated_at": "2024-01-11T01:42:45.369083+00:00",
"user_id": null,
"zip_code": "90013"
},
"old_values": {
"active": true,
"avatar": null,
"birth_date": null,
"city": null,
"created_at": "2023-01-17T18:14:15.755276+00:00",
"deleted_at": null,
"email_address": null,
"email_okay": false,
"first_name": "Student",
"id": "6bb39dcd-820b-4d75-98f6-d5604d5abcec",
"last_name": "Student",
"middle_name": "Student",
"phone_number": null,
"preferred_language": null,
"reference_id": null,
"sms_okay": false,
"state": null,
"street_address": null,
"street_address_line_2": null,
"updated_at": "2023-07-11T16:58:50.452099+00:00",
"user_id": null,
"zip_code": null
},
"organization_id": "8fb9823c-10c6-47bd-9fed-893898c413ee",
"transaction_type": "UPDATE",
"updated_at": "2024-01-11T01:42:45.369083+00:00"
}
Form Submission (From InProgress to Submitted)
{
"created_at": "2024-01-17T23:04:44.251835+00:00",
"deleted_at": null,
"entity_id": "98a1bc18-f12b-41c8-8117-1f7cfafa65be",
"entity_type": "FORM",
"id": "61e18f9a-0f29-476e-a724-1c3e12152c97",
"modified_by_user_id": "auth0|63979ef9df8e4093d979f014",
"name": "FORM_SUBMITTED",
"new_values": {
"enrollment_period_id": "974439c4-50d9-4901-a05b-86be7ec3903b",
"form_template_id": "1becd5fc-f091-48c3-b250-3119ff1867a0",
"form_template_key": "application-form",
"id": "98a1bc18-f12b-41c8-8117-1f7cfafa65be",
"organization_id": "8fb9823c-10c6-47bd-9fed-893898c413ee",
"status": "Submitted"
},
"old_values": {
"enrollment_period_id": "974439c4-50d9-4901-a05b-86be7ec3903b",
"form_template_id": "1becd5fc-f091-48c3-b250-3119ff1867a0",
"form_template_key": "application-form",
"id": "98a1bc18-f12b-41c8-8117-1f7cfafa65be",
"organization_id": "8fb9823c-10c6-47bd-9fed-893898c413ee",
"status": "InProgress"
},
"organization_id": "8fb9823c-10c6-47bd-9fed-893898c413ee",
"transaction_type": "UPDATE",
"updated_at": "2024-01-17T23:04:44.251835+00:00"
}
Offer Accepted (From Offer to Accepted)
{
"created_at": "2024-01-18T16:42:49.675517+00:00",
"deleted_at": null,
"entity_id": "0debd283-e62e-4ce0-a094-3d713e12d00d",
"entity_type": "OFFER",
"id": "b1a363ac-0671-454a-ab3a-525ab182ef60",
"modified_by_user_id": "auth0|651ad4bff1d7142df679037f",
"name": "OFFER_ACCEPTED",
"new_values": {
"enrollment_period_id": "90d172a7-c3c7-4bbc-87b9-0382d5c2338f",
"form_id": "c67c7e17-30d9-4c27-8906-a19eade84f19",
"form_template_id": "f96800af-3a69-47e1-8842-655cd7e6eb65",
"form_template_key": "application-form",
"id": "0debd283-e62e-4ce0-a094-3d713e12d00d",
"organization_id": "695d45d3-3e6d-44d5-bc96-d2b85e90349e",
"status": "Accepted"
},
"old_values": {
"enrollment_period_id": "90d172a7-c3c7-4bbc-87b9-0382d5c2338f",
"form_id": "c67c7e17-30d9-4c27-8906-a19eade84f19",
"form_template_id": "f96800af-3a69-47e1-8842-655cd7e6eb65",
"form_template_key": "f96800af-3a69-47e1-8842-655cd7e6eb65",
"id": "0debd283-e62e-4ce0-a094-3d713e12d00d",
"organization_id": "695d45d3-3e6d-44d5-bc96-d2b85e90349e",
"status": "Offered"
},
"organization_id": "695d45d3-3e6d-44d5-bc96-d2b85e90349e",
"transaction_type": "UPDATE",
"updated_at": "2024-01-18T16:42:49.675517+00:00"
}
Waitlist removed (From Waitlisted to Removed)
{
"created_at": "2024-01-18T19:08:32.890924+00:00",
"deleted_at": null,
"entity_id": "2015542a-e002-4114-836f-0ee24592e91d",
"entity_type": "WAITLIST",
"id": "6812c967-e624-456b-a46f-6be0f5c36420",
"modified_by_user_id": "auth0|63c6ee4518a87addc95dd800",
"name": "WAITLIST_REMOVED",
"new_values": {
"enrollment_period_id": "974439c4-50d9-4901-a05b-86be7ec3903b",
"form_id": "779f79ad-4c30-412b-be68-fd2845479376",
"form_template_id": "1becd5fc-f091-48c3-b250-3119ff1867a0",
"form_template_key": "1becd5fc-f091-48c3-b250-3119ff1867a0",
"id": "2015542a-e002-4114-836f-0ee24592e91d",
"organization_id": "8fb9823c-10c6-47bd-9fed-893898c413ee",
"status": "Removed"
},
"old_values": {
"enrollment_period_id": "974439c4-50d9-4901-a05b-86be7ec3903b",
"form_id": "779f79ad-4c30-412b-be68-fd2845479376",
"form_template_id": "1becd5fc-f091-48c3-b250-3119ff1867a0",
"form_template_key": "1becd5fc-f091-48c3-b250-3119ff1867a0",
"id": "2015542a-e002-4114-836f-0ee24592e91d",
"organization_id": "8fb9823c-10c6-47bd-9fed-893898c413ee",
"status": "Waitlisted"
},
"organization_id": "8fb9823c-10c6-47bd-9fed-893898c413ee",
"transaction_type": "UPDATE",
"updated_at": "2024-01-18T19:08:32.890924+00:00"
}
Webhook configuration
Avela supports the following authentication methods
API Key
- Header name
- API Key
Basic Auth
- Username
- Password
Bearer Token
- Bearer token
To configure a webhook, share the list of events you desire with your client services manager and the Endpoint URL and authentication methods. We recommend One Time Secret for sharing authentication secrets.
Comments
0 comments
Please sign in to leave a comment.