An Event is logged by Edlink when data is created, updated, or deleted for an Integration.
The Events API allows you to sync only data that has changed (deltas). Events are automatically generated when entities are created, updated, or deleted. Events belong to a single integration.
Events Deltas API Guide
Developer Guide
Click to Read
Properties
| Property | Type | Description |
|---|---|---|
id | string | The UUID for the object. |
date | Date | When the event occurred. |
type | EventType | The type of the event. |
target | EventTarget | The target of the event. |
target_id | string | The UUID of the associated object. The type of this object depends on the value of target. |
integration_id | string | The UUID of the associated Integration. |
materialization_id | string | The UUID of the associated Materialization. |
data | object | The new value of the target object after the event occurred. |
JSON Example
{
"id": "ed19659c-a490-40bc-b1e7-1e50b293fa78",
"date": "2025-12-23T20:51:23.064Z",
"type": "created",
"target": "person",
"target_id": "d1ce2055-4121-400c-b3b0-c8c436501b0a",
"integration_id": "dd62026c-1180-40ca-a614-ae537f766cb4",
"materialization_id": "1545efd4-71c0-40a0-8d10-8210d4216e22",
"data": {
"created_date": "2025-12-23T20:51:23.064Z",
"updated_date": "2025-12-23T20:51:23.064Z",
"properties": {},
"first_name": "Random",
"middle_name": null,
"last_name": "Fake-Person",
"display_name": "Some Random Guy",
"picture_url": null,
"email": "example@mail.com",
"phone": null,
"locale": null,
"time_zone": null,
"graduation_year": null,
"letter_grade": null,
"gpa": null,
"demographics": {
"birthday": null,
"gender": null,
"residence_status": null,
"english_language_learner": null,
"country_of_birth": null,
"state_of_birth": null,
"city_of_birth": null,
"hispanic_or_latino_ethnicity": null,
"races": [],
"homeless": null,
"disability": null,
"gifted_talented": null,
"food_service_program_eligibility": null,
"economically_disadvantaged": null,
"migrant": null,
"public_assistance": null,
"rural_residency": null,
"individualized_education_plan": null,
"primary_language": null,
"special_accommodations": null,
"military_connected": null
},
"address": {
"street": null,
"unit": null,
"postal_code": null,
"city": null,
"state": null,
"country": null
},
"product_ids": [],
"identifiers": [
],
"id": "d1ce2055-4121-400c-b3b0-c8c436501b0a",
"roles": [
"student"
],
"grade_levels": [],
"district_id": "47ccd493-ec1c-4cb1-9c1f-627a42dccdac",
"school_ids": [],
"department_ids": []
}
}