HEheysavvy
Events

POST /projects/{projectId}/events

Changed on

Submit a custom event for an entry

Request

  • Base URL
    https://api.embeddables.com
  • URL
    https://api.embeddables.com/projects/{projectId}/events
  • Auth
    none declared. Required headers: X-Api-Key

Path parameters

projectIdstring required

The unique identifier for a Project in the database

Headers

X-Api-Keystring required

Request body

embeddable_idstring required

The unique identifier for a Embeddable in the database

timestampstring required

A Date + Time string in ISO format

custom_event_namestring required

A name of your choosing for the custom event - must be snake_case

custom_event_propsstring required

Any custom properties you want to attach to the custom event - must be a valid JSON string

Response

entry_idstring required

The unique identifier for an Entry in the database

contact_idstring required

The unique identifier for a Contact in the database

project_idstring required

The unique identifier for a Project in the database

group_idstring required

The unique identifier for a Group in the database

embeddable_idstring required

The unique identifier for a Embeddable in the database

embeddable_version_numberinteger

The version number of an embeddable

timestampstring required

A Date + Time string in ISO format

page_idstring
page_keystring
page_indexinteger
max_page_idstring
max_page_keystring
max_page_indexinteger
total_pagesinteger nullable
event_typestring required
view_typestring
custom_event_namestring nullable
custom_event_propsstring nullable

Changes