For Developers

Application Overview

An Application represents a developer application registered on a team. Applications define the credentials, webhook subscribers, origin policies, and audit schemas used to connect to learning institutions and sync educational data.

Properties

PropertyTypeDescription
idUUIDStable unique identifier for the application.
created_dateDateDate when the application was registered.
updated_dateDateDate when the application was last updated.
nameStringHuman-readable name of the application.
descriptionStringOptional description of the application.
originStringOptional origin domain for client-side integrations (e.g. https://app.example.com).
propertiesObjectCustom application metadata and configuration flags.
materialization_thresholdsObjectMaterialization thresholds for record counts before triggers.
team_idUUIDIdentifier of the team that owns the application.

JSON Example

{
    "id": "7ebf2dc9-ab3b-448f-9b15-0b38e71f81c9",
    "created_date": "2024-01-15T08:00:00.000Z",
    "updated_date": "2024-06-20T12:00:00.000Z",
    "name": "Acme Learning LMS Integration",
    "description": "Enterprise application integration with LMS providers.",
    "origin": "https://app.acmelearning.com",
    "properties": {
        "sandbox": false
    },
    "team_id": "d078e26d-9fcc-4f2b-b19f-430891906061"
}