⚙️ Actions Documentation

Table of Contents

1. Introduction
2. Install and Uninstall (Mandatory Configuration)
   • Install Action
   • Uninstall Action
3. HMAC Signature Verification
4. Action Categories

Introduction

This documentation describes the actions triggered when a user navigates through the platform. Each page load sends a request corresponding to a specific action.

Install and Uninstall (Mandatory Configuration)

The install and uninstall actions are not standard actions but required URLs that must be configured in the Edusign interface. Unlike regular actions, they do not correspond to user navigation events but are essential for the application's lifecycle.

Install Action

Description

Must be triggered when the application is installed.

Headers

{
  "x-edusign-webhook-type": "test-install-app",
  "x-edusign-school-id": "school_id_placeholder",
  "x-edusign-app-id": "app_id_placeholder",
  "x-edusign-lang": "en",
  "x-edusign-hmac": "hmac_placeholder",
  "x-edusign-client-id": "client_id_placeholder"
}

Body

{
  "parametersValues": {},
  "parameters": [],
  "schoolId": "school_id_placeholder",
  "client_id": "client_id_placeholder",
  "client_secret": "client_secret_placeholder",
  "token": "token_placeholder"
}

Expected Response

{
  "status": "success",
  "message": "The application has been successfully installed."
}

Uninstall Action

Description

Must be triggered when the application is uninstalled.

Headers

{
  "x-edusign-webhook-type": "test-uninstall-app",
  "x-edusign-school-id": "school_id_placeholder",
  "x-edusign-app-id": "app_id_placeholder",
  "x-edusign-lang": "en",
  "x-edusign-hmac": "hmac_placeholder",
  "x-edusign-client-id": "client_id_placeholder"
}

Body

{
  "schoolId": "school_id_placeholder"
}

Expected Response

{
  "status": "success",
  "message": "The application has been successfully uninstalled."
}

HMAC Signature Verification

To ensure the integrity of incoming requests, the HMAC signature must be validated. The HMAC is computed using the client_secret that was provided during the application's installation. Each school has its own unique client_secret, which should be securely stored by the developer.

The HMAC signature is calculated over the JSON-stringified body of the request.

Using Edusign's SDK

To simplify verification, you can use the official Edusign SDK:

import Edusign from '@_edusign/api';

const hmacTester = new Edusign.Webhooks(clientSecret);

if (!hmacTester.verifyWebhookSignature(req.hmac!, JSON.stringify(req.body))) {
  throw new Error('HMAC validation failed');
}

Action Categories

The platform actions are divided into three main categories:

• Admin Platform
  Includes actions related to the administrative management of the admin platform.
• Professor Platform
  Includes actions related to interactions on the professor platform.
• Student Platform
  Includes actions related to interactions on the student platform.