Skip to main content
Looking for the JavaScript API?
Events are processed asynchronously (typically within thirty seconds). Events and their properties can be used for Segmentation, Goals, Launcher item completed etc. Events tracked for users that have not yet been seen by Chameleon will be created first and then the event tracked to them

Create an Event

HTTP Request

POST https://api.chameleon.io/v3/observe/hooks/events
# OR
POST to https://api.chameleon.io/v3/observe/hooks/:account_secret/events
param-description
idoptionalThe Chameleon ID of the User Profile
uidoptionalThe User Profile Identifier (typically the Database ID from your backend)
namerequiredThe name of the Event (“Imported Data” or “Completed Task”)
*othersoptionalAll other properties will be added to the Event
{
  "uid": 18821,
  "name": "Scheduled follow up",
  "scheduling_link": "https://acme.claendly.com/meetings/round-robin/15-min"
}

HTTP Response

{
  "event": {
    "id": "5f3c4232c712de665632a2a3"
  }
}

Event properties

All other properties will be added to the Event and will be made available for creating Custom Events.
{
  "uid": 18821,
  "name": "Scheduled follow up",
  "scheduling_type": "demo",
  "scheduling_source": "upsell",
  "scheduling_link": "https://acme.claendly.com/meetings/round-robin/15-min"
}
{
  "uid": 18821,
  "name": "Payment succeeded",
  "plan": "Enterprise",
  "amount": "129500",
  "lifetime_value": "42905000",
}

Normalized Event naming

By default, Events are grouped by their case insensitive and normalized name value. The following are all counted as the Same Event
  • “Imported Leads” => imported_leads
  • “ImporteD leads” => imported_leads
  • “imported-leads” => imported_leads
To know more about how Events are normalized, visit the Normalization page.