Skip to main content
POST
/
api
/
v1
/
events
curl --request POST \
  --url https://api.vambe.me/api/v1/events \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "event": "purchase",
  "properties": {
    "orderId": "ORD-123",
    "total": 49990,
    "currency": "CLP"
  },
  "contact": {
    "phone": "+56911112222",
    "name": "Jane Doe",
    "email": "jane@example.com"
  },
  "channel": {
    "channelPhone": "+56999999999"
  }
}
'
{
  "id": "df980fc8-b6db-4820-bf22-2969482d106d"
}

Documentation Index

Fetch the complete documentation index at: https://docs.vambe.me/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-api-key
string
required

API key used to authorize the request

Body

application/json

Event payload. contact requires at least one of aiContactId or phone; channel requires at least one of channelId or channelPhone.

​
event
string
required
Required string length: 1 - 100
​
properties
object
required
​
contact
object
required
​
channel
object
required
​
occurredAt
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Response

Event accepted for asynchronous processing. Returns the generated event id.

​
id
string<uuid>
Example:

"df980fc8-b6db-4820-bf22-2969482d106d"