Where can I read the API documentation?
Read our documentation here. We've created five IntentEvent endpoints:
1. Create Intent Events
Create a new intent event to track booking-related interactions and metadata
2. Get Intent Events
Retrieve a paginated list of intent events with optional filtering
3. Delete Intent Events
Delete an intent event by its unique identifier.
4. Get Intent ID by Events
Get an intent event by its unique identifier.
5. Update Intent Event
Update an existing intent event. Only certain fields can be updated.
What information can I share?
You can capture both what a customer purchased and what they intended to purchase, along with associated values all linked to a specific booking, customer, and store.
The two key fields are eventData and metadata, both of which are open {} objects - meaning they accept any arbitrary key-value data you want to pass in. This gives you the flexibility to send through whatever information you'd like.
For example:
"eventData": {
"purchasedItems": [
{ "product": "Silk Blouse", "price": 89.00 },
{ "product": "Linen Trousers", "price": 65.00 }
],
"intendedItems": [
{ "product": "Cashmere Jumper", "price": 120.00 }
]
}"eventData": {
"purchasedProduct": "Silk Blouse",
"purchasedValue": 89.00,
"intendedProduct": "Cashmere Jumper",
"intendedValue": 120.00,
"currency": "GBP"
}
Other useful fields:
source - to could identify the channel (e.g. in-store POS)
timestamp - records when it happened
customerBookingId - ties it all back to the original booking and customer.