logoPlatzi Event Catalog

EnterCard
v1.0.0

The student enters in a home card.
Open in Visualiser →

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 the user enters in a home card
Rules: N/A
Static Values:
  • event_type: enter_card
  • event_name: platzi.cards.1.enter_card
event_id
string<uuid>
required

Id for the event. This is a client auto-generated UUID_V4

event_name
string
required

Name of the event with format organization.domain.version.action

event_occurred_on
string<date-time>
required

DateTime when the event was raises. Format YYYY-MM-DDTHH:MM:SSz

attributes
object
required

Contains arbitrary properties with entity information

key
string
required

typeof learningPath | course | short

value
string
required

id of selected type

metadata
object
required

Contain fixed properties with event information

event_type
string
required

Type 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.cards.1.enter_card",
6  "event_occurred_on": "2023-05-01T22:29:56Z",
7  "attributes": {
8    "value": "1",
9    "key": "short"
10  },
11  "metadata": {
12    "event_type": "enter_card"
13  }
14}'
Edit this pageLast updated on 2025/2/18