POST /events

Log an event of any form to the Froomle Event API.

POST /events

Parameters

Type Name Schema

Body

body
required

body

Name Schema

events
required

< object > array

Responses

HTTP Code Description Schema

201

Event was stored.

No Content

400

The event body was not in the right format or was missing mandatory information.

No Content

415

The event body is not of type json.

No Content

500

Something went wrong while processing

No Content

Consumes

  • application/json


Event

For all events that can be used in the froomle integration see concepts/Events

Polymorphism : Composition

Name Description Schema

action_item
required

The item id of the item interacted with

string

cookie_id
required

Unique identifier of the current user’s session, usually stored in a cookie

string

event_type
optional

needs to be exactly Event

string

user_id
optional

User id of the authenticated user

string