Sign in

v1

latestOpenAPI 3.1.02026-07-141045121.7 KB
Xapi

xAPI Course Started

Sent to your endpoint when a learner starts a course on the platform. This event is a statement following the xAPI specification.

postWebhookxapi.started

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

idstring uuid required

The unique ID of the statement.

timestampstring date-time required

The date and time when the activity was started, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

Example payload

{
  "id": "6b951307-9deb-47f5-b8f9-65e505bac3e4",
  "actor": {
    "mbox": "mailto:john.smith@yopmail.com"
  },
  "verb": {
    "display": {
      "en-US": "initialized"
    }
  },
  "object": {
    "id": "urn:360learning:course:507f1f77bcf86cd799439011",
    "definition": {
      "name": {
        "en-US": "My course name"
      },
      "description": {
        "en-US": "My course description"
      }
    }
  },
  "context": {
    "contextActivities": {
      "parent": [
        {
          "id": "urn:360learning:path:507f1f77bcf86cd799439045"
        }
      ],
      "other": [
        {
          "id": "urn:360learning:session:507f1f77bcf86cd799439011"
        }
      ]
    }
  }
}

Response

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