Startedv1.0.0
The student sees a material for first time.
Details
This event must be consumed using an authorization token. The token is utilized to verify that the user has permission to produce the event and set user_id and organization_id within the attributes. Additionally, the event_source and metadata.event_triggered_by are automatically populated by the CF-Worker-User-Event.
Triggered: when a material is seen by first time
Rules:
- Triggered once only
- This event should not be duplicated
- is_seen is false
Static Values:
- event_type: started
- event_name: platzi.material_progress.1.started
- attributes.value: true
event_id
string<uuid>Id for the event. This is a client auto-generated UUID_V4
event_name
stringName of the event with format organization.domain.version.action
event_occurred_on
string<date-time>DateTime when the event was raises. Format YYYY-MM-DDTHH:MM:SSz
attributes
objectContains arbitrary properties with entity information
material_id
integerMaterial identifier
course_id
integerCourse identifier
key
stringText combining the user_id and material_id
value
stringEvent value
metadata
objectContain fixed properties with event information
event_type
stringType of the event, used to join common sub events
How to trigger this event
1curl --location 'https://api-c963080767f45828c31f83ca5cd25d36.staging.platzi.com/behavior/v1/' \
2--header 'Content-Type: application/json' \
3--data '{
4 "event_id": "2457207d-a9d8-4b46-aff3-2a8ca385f2f6",
5 "event_name": "platzi.material_progress.1.started",
6 "event_occurred_on": "2023-05-01T22:29:56Z",
7 "attributes": {
8 "course_id": 1,
9 "material_id": 1,
10 "value": "true",
11 "key": "1-1"
12 },
13 "metadata": {
14 "event_type": "started"
15 }
16}'Edit this pageLast updated on 2025/2/18