Events

By Jaron Pate

Last Updated August 11th, 2025

Events are the payload sent to your subscribers. They represent actions taken on the Edlink platform, such as user logins, integration updates, or materialization failures. Each event has a specific type and a payload that contains relevant information about the event.

Event Structure

Each event is structured as a JSON object with the following fields:

type: The type of the event (e.g. person.login, materialization.scheduled).
date: The timestamp of when the event occurred.
payload: An object containing additional information specific to the event type.

{
    "type": "person.login",
    "date": "2024-08-11T12:34:56Z",
    "payload": {
        "integration_id": "string",
        "materialization_id": "string"
    }
}

Event Types

Click on an event type below to see its details:

Type	When
`person.login`	Emitted when a standard login is performed by a Person into your Application, (e.g. via Edlink's sso page).
`person.login.lti`	Emitted when a LTI login is performed by a Person into your Application.
`person.login.scoped`	Emitted when a scoped login is performed by a Person into your Application (typically this is the Edlink Widget authenticating).
`person.login.error`	Emitted when a login is attempted but fails.
`person.login.initiated`	Emitted when a Person initiates a login into your Application.
`application.secret.created`	Emitted when a new secret is created on your Application.
`application.secret.deleted`	Emitted when a secret is deleted from your Application.
`integration.created`	Emitted when a new integration is created between a Source and your Application. This usually occurs during onboarding.
`integration.updated`	Emitted when an integration's properties is updated.
`integration.marked_for_deletion`	Emitted when an integration's state is changed to `destroyed`. It will be deleted within 3 days.
`integration.destroyed`	Emitted when an integration is actually destroyed. This action is irreversible.
`materialization.scheduled`	Emitted when a new materialization is scheduled. Typically as the result of a change to sharing rules, transformations, etc.
`materialization.started`	Emitted when a materialization is claimed and starts running.
`materialization.completed`	Emitted when a materialization finished successfully.
`materialization.error`	Emitted when a materialization fails.
`materialization.data_changed`	Emitted when a materialization finished and resulted in data being changed.

Events

Events can vary based on the actions taken on the platform. Here are the current event types you can expect to receive:

Fields that are not required could be omitted from the payload or be null / undefined.

Emitted when a standard login is performed by a Person into your Application, (e.g. via Edlink's sso page).

Field	Required	Description
`application_id`	✅	The UUID of the application the login is for.
`integration_id`	❔	The UUID of the integration the login is for (if known).
`person_id`	❔	The UUID of the person that is logging in (if known).

Field	Required	Description
`application_id`	✅	The UUID of the application the secret is for.
`credential_id`	✅	The UUID of the credential that was created.

Field	Required	Description
`integration_id`	✅	The UUID of the integration the materialization is for.
`application_id`	✅	The UUID of the application the integration is for.
`source_id`	✅	The UUID of the source the integration is for.
`destination_id`	❔	The UUID of the destination the integration is for.
`permissions`	✅	The permissions granted to the integration.
`properties`	✅	The properties of the integration.
`status`	✅	The status of the integration.
`region_id`	✅	The UUID of the region the integration is in.

Field	Required	Description
`integration_id`	✅	The UUID of the integration the materialization is for.
`materialization_id`	✅	The UUID of the materialization that was scheduled.