Skip to main content
POST
/
events
Events API
curl --request POST \
  --url https://api.example.com/events \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity_external_id": "<string>",
  "name": "<string>",
  "properties": {}
}
'

​
Record Event

​
entity_external_id
string
required
The external ID of the entity
​
name
string
required
Name of the event
​
properties
object
Additional properties for the event
curl -X POST https://api.limejourney.com/events \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entity_external_id": "customer123",
    "name": "purchase",
    "properties": {
      "amount": 99.99,
      "product": "premium"
    }
  }'

​
Example Response

{
  "status": "success",
  "data": {
    "id": "evt_123",
    "entity_external_id": "customer123",
    "name": "purchase",
    "properties": {
      "amount": 99.99,
      "product": "premium"
    },
    "timestamp": "2024-01-15T12:00:00Z"
  }
}