For Developers

Events

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

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

? = optional field

TypePayload Fields
person.loginintegration_id?, application_id?, person_id?
person.login.ltiintegration_id?, application_id?, person_id?
person.login.scopedintegration_id?, application_id?, person_id?
person.login.errorintegration_id?, application_id?, person_id?
person.login.initiatedintegration_id?, application_id?, person_id?
application.secret.createdapplication_id, credential_id
application.secret.deletedapplication_id, credential_id
materialization.scheduledintegration_id, materialization_id
integration.createdintegration_id, application_id, source_id, destination_id, permissions, properties, status, region_id, team_id
integration.updatedintegration_id, application_id, source_id, destination_id, permissions, properties, status, region_id
integration.marked_for_deletionintegration_id, application_id, source_id, destination_id, permissions, properties, status, region_id
integration.destroyedintegration_id, application_id, source_id, destination_id, permissions, properties, status, region_id