xAPI Course Started

wbhk

xapi.started

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

Payload

The payload sent to your endpoint when the event is triggered.

uuid

required

The unique ID of the statement.

actor

required

The agent or group who performed the action. The email schema is used by default and the username schema is only used if the company allow the usage of a username to log in.

verb

object

required

The action between the actor and the object.

object

required

The activity or agent undergoing the action.

context

object

required

The contextual information of the statement.

timestamp

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)).

Headers

webhook-signature

string

required

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

webhook-id

string

required

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

webhook-timestamp

string

required

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

Responses

2XX

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

default

The event is considered as rejected for any other response code. The event emission will be retried later.

Loading…