UserUpdate
v1.0.0

Change the student info like name, last name, username, limit date, country from Sherlock.

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 success team changes the student's info
Rules:N/A
Static Values:
  • event_type: user_update
  • event_name: platzi.sherlock.1.user_update
  • attributes.value: true/false
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

username
string
required

Platzian username

student_id
integer
required

Student identifier

key
string
required

Text combining user_update text and student_id value

value
string
required

Event value

changes
object
required

Contains the changes made to the entity

prev
object
required

Previous values

key
string

key may be user_type|limit_date|company_id|first_name|last_name|username|country|role

value
string or integer

Previous value

new
object
required

New values

key
string

key may be user_type|limit_date|company_id|first_name|last_name|username|country|role

value
string or integer

new value

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.sherlock.1.user_update",
6  "event_occurred_on": "2023-05-01T22:29:56Z",
7  "attributes": {
8    "username": "organizer",
9    "student_id": 1,
10    "value": "user_update-1",
11    "key": "true"
12    "changes":{
13      "new":{
14        "country":"",
15        "limit_date":"24/9/2023"
16      },
17      "prev":{
18        "country":null,
19        "limit_date":"22/9/2023"
20      }
21    },
22  },
23  "metadata": {
24    "event_type": "user_update"
25  }
26}'
27
Edit this pageLast updated on 2025/2/18