Sign in

v1

latestOpenAPI 3.1.02026-07-141045121.7 KB
Course

Course attempt closed

Sent to your endpoint when an attempt is closed. This event is currently triggered only when learners finish an attempt, materialized through the reason attribute. The reason attribute potential values are expected to grow over time as new closure reasons will be supported.

postWebhookcourse.attempt.closed

Headers

webhook-signaturestring required
Example:v1,4UHnozIIxoqswxyYsplgMpo1w5JaUjaPDlg5dm8n1SE=

The signature of the event payload, used to verify the authenticity of the event. If multiple signatures are present, they are space delimited.

webhook-idstring required
Example:msg_35bE2UOtsaBIqUl7VW4mLuR9q2B

The unique identifier of the event. It is the same ID for the retry attempts of the same event.

webhook-timestampstring required
Example:1763370163

The date and time when the event was emitted, in the Unix epoch format (number of seconds that have elapsed since January 1, 1970).

Payload

type'course.attempt.closed' required

The type of the event.

timestampinteger required

The date and time when the event was triggered in your platform, in the Unix epoch format (number of milliseconds that have elapsed since January 1, 1970).

Example payload

{
  "type": "course.attempt.closed",
  "data": {
    "attemptId": "507f1f77bcf86cd799439011",
    "userId": "507f1f77bcf86cd799439011",
    "courseId": "507f1f77bcf86cd799439011",
    "context": {
      "pathId": "507f1f77bcf86cd799439011",
      "pathSessionId": "507f1f77bcf86cd799439011"
    }
  }
}

Response

The event is considered as accepted for any 2xx response code.