View Dashboard

Description

Triggered when a student accesses their dashboard.

Headers

{
  "x-edusign-webhook-type": "app-form-completion",
  "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

{
  "ACTION": "apicall",
  "LOCATION": "view_dashboard",
  "caller": {
    "userId": "user_id_placeholder",
    "userType": "student",
    "appId": "app_id_placeholder",
    "schoolId": "school_id_placeholder"
  },
  "context": {
    "studentId": "student_id_placeholder",
    "schoolId": "school_id_placeholder"
  },
  "environment": {}
}

Expected Response

[
  {
    "id": "unique_id_5",
    "block": "title",
    "text": "Student Dashboard"
  },
  {
    "id": "unique_id_6",
    "block": "text",
    "text": "# Welcome to your dashboard\nHere's an overview of your courses, grades, and other details."
  }
]

View Course

Description

Triggered when a student accesses a specific course's details.

Headers

{
  "x-edusign-webhook-type": "app-form-completion",
  "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

{
  "ACTION": "apicall",
  "LOCATION": "view_course",
  "caller": {
    "userId": "user_id_placeholder",
    "userType": "student",
    "appId": "app_id_placeholder",
    "schoolId": "school_id_placeholder"
  },
  "context": {
    "courseId": "course_id_placeholder",
    "schoolId": "school_id_placeholder"
  },
  "environment": {}
}

Expected Response

[
  {
    "id": "unique_id_7",
    "block": "title",
    "text": "Course Details"
  },
  {
    "id": "unique_id_8",
    "block": "text",
    "text": "# Course Overview\nDetailed information about the course you are enrolled in."
  }
]