Upmarket API Docs home pagelight logo
Events
Create
POST

/events/create

x-upmarket-key*
curl --request POST \
  --url https://api.upmarket.ai/events/create \
  --header 'x-upmarket-key: xxxxxxxxxxxxxxxxxxx' \
  --data '{
  "journey_id": "<journey_id>",
  "customer_id": "<customer_id>",
  "event_id": "<event_id>"
}'

Every Event streamed to Upmarket must include a customer_id, and journey_id.

To get the customer_id, use the customers/initialize endpoint.

journey_id

Get the journey_id from Upmarket

x-upmarket-keyrequiredDefault: "xxxxxxxxxxxxxxxxxxx"

This is the API Key you generated from Upmarket.

​
Body

journey_idrequired
string

Id of the Journey this event is associated with.

customer_idrequired
string

The customer this event is associated with.

event_idrequired
string

This is the Event Id that you’re streaming to Upmarket. An example of an event_id is sign_up.

your_variables
string

Add custom variables to stream to Upmarket.

​
Response

success
string

Indicates that the event was saved successfully

curl --location --request POST 'https://api.upmarket.ai/events/create' \
--header 'Content-Type: application/json' \
--header 'x-upmarket-key: xxxxxxxxxxxxxxxxxxx' \
--data-raw '{
    "event_id": "",
    "journey_id": ""
}'

{
  "success"
}