For Developers

Integration Status Widget

The integration status plugin adds a embeddable frame to your site which show the status of the users integration with your platform. It will show when their source last synced and allow them to manually queue a sync.

Integration Status Plugin Preview
Integration Status Plugin Preview

Usage

1. Installation

First add the Widgets SDK script to your website. You can do this by adding the following script tag to your website:

<script src="https://ed.link/widgets/edlink@1.0.0.js"></script>

2. Initialization

Then initialize the SDK.

const edlink = new Edlink({
    client_id: `00000000-0000-0000-0000-000000000000`
    colors: {
        primary: '#e63946',
        primary_foreground: '#ffffff'
    }
});

Next create a widget instance with a root for the widget to mount to and an email to authenticate the user with.

const widget = edlink.createWidget({
    root: document.getElementById('edlink-widget-root'),
    email: 'jaron@k12.mnps.org'
});

3. Activation

Activate the plugin like so:

widget.activatePlugin({
    name: 'integration_status',
    options: {
        integration_id: '00000000-0000-0000-0000-000000000000'
    }
});

The widget will automatically appear because it is attached to a root element. No need to call show().

This widget will resize itself to fit its contents. It will set a fixed height on its iframe but you are welcome to constrain it with the root however you like. We reccomend placing it in an element that is free to resize in the y-axis.