CommentsReport
v1.0.0

Report comments in Material View

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:(ToDo) Explanation of the trigger
Rules:
  • (ToDo) Rule 1
  • (ToDo) Rule 2
Static Values:
  • event_name: platzi.material_progress.1.comments_report
  • attributes.key: comments_report
  • attributes.value: true
  • metadata.comment_id: the comment id
  • metadata.report_description: the description of the report
  • metadata.comment: the comment
  • metadata.material_id: the material_id
  • metadata.course_id: the course_id
  • metadata.class_url: the class url
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

Report Comment

value
string
required

true

metadata
object
required

Contain fixed properties with event information

comment_id
integer
required

Id of the selected comment to report

report_description
string
required

Text written by the student who wants to report a comment which discribe the reason of the report

comment
string
required

Content of the reported comment

material_id
integer
required

Material Identifier

course_id
integer
required

Course Identifier

class_url
string
required

Url of the class

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.comments_report",
6  "event_occurred_on": "2023-05-01T22:29:56Z",
7  "attributes": {
8    "key": "comments_report",
9    "value": "true"
10  },
11  "metadata": {
12    "comment_id": 1234,
13    "report_description": "Este comentario no me gusto",
14    "comment": "Gracias, este contenido del curso no me aporta",
15    "material_id": 4325,
16    "course_id": 1234,
17    "class_url": "https://..."
18  }
19}'
20
Edit this pageLast updated on 2025/2/18