An Event is logged by Edlink when data is created, updated, or deleted for a Source.
The Events API allows you to sync only data that has changed (deltas). Events are automatically generated when people, enrollments, terms, and organizations are created, updated, or deleted. Events are scoped to a single integration.
Check out our full guide on the Events API for in-depth instructions and examples.
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": "00000000-0000-0000-0000-000000000000",
"date": "2021-07-26T06:15:47.179Z",
"type": "deleted",
"target": "person",
"target_id": "00000000-0000-0000-0000-000000000000",
"integration_id": "00000000-0000-0000-0000-000000000000",
"materialization_id": "00000000-0000-0000-0000-000000000000",
"data": {
...
}
}