POST
/
projects
/
{projectId}
/
events
curl --request POST \
  --url https://api.embeddables.com/projects/{projectId}/events \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '{
  "embeddable_id": "flow_myexampleflow",
  "timestamp": "2022-01-01T00:00:00.000Z",
  "custom_event_name": "my_custom_event",
  "custom_event_props": "{ \"my_prop\": \"my_val\" }",
  "identifiers": [
    {
      "key": "email",
      "value": "\"test@test.com\""
    }
  ]
}'
{
  "group_id": "group_myexamplegroup",
  "project_id": "pr_myexampleproject",
  "embeddable_id": "flow_myexampleflow",
  "embeddable_version_number": 1,
  "contact_id": "contact_myexamplecontact",
  "entry_id": "entry_myexampleentry",
  "timestamp": "2022-01-01T00:00:00Z",
  "event_type": "custom_event:triggered",
  "custom_event_name": "my_custom_event",
  "custom_event_props": "{ \"my_prop\": \"my_val\" }"
}

Headers

​
X-Api-Key
string
required

Path Parameters

​
projectId
string
required

The unique identifier for a Project in the database

Body

application/json
​
embeddable_id
string
required

The unique identifier for a Embeddable in the database

​
timestamp
string
required

A Date + Time string in ISO format

​
custom_event_name
string
required

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

​
custom_event_props
string
required

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

​
identifiers
object[]
required

A list of key-value pairs that uniquely identify the end-user that this event should be attached to. Currently supports one key-value pair. The value must be JSON-stringified, so strings must be wrapped in double-quotes.

Response

200
application/json
​
entry_id
string
required

The unique identifier for an Entry in the database

​
contact_id
string
required

The unique identifier for a Contact in the database

​
project_id
string
required

The unique identifier for a Project in the database

​
group_id
string
required

The unique identifier for a Group in the database

​
embeddable_id
string
required

The unique identifier for a Embeddable in the database

​
timestamp
string
required

A Date + Time string in ISO format

​
event_type
string
required
​
embeddable_version_number
integer

The version number of an embeddable

​
page_id
string
​
page_key
string
​
page_index
integer
​
max_page_id
string
​
max_page_key
string
​
max_page_index
integer
​
total_pages
integer | null
​
view_type
string
​
custom_event_name
string | null
​
custom_event_props
string | null

Was this page helpful?

Suggest editsRaise issue