Use of this API requires a partner API Key. To obtain such a key, contact your Booxi representative.
Also, your partner API key and webhook endpoint must have been configured/authorized for a module in order to access its linked data.
Prior to use, consult Booxi's API fair use policy.
Remember that the URL at which you access the API depends on your hosting region. This article presents examples from a North American hosting only.
API documentation links:
Additional information saved along a client's records can be retrieved using the Booxi API. An external ID and its associated metadata could be employed to synchronize your CRM with the content of a Booxi’s client record. The following article will present how to retrieve and update metadata from a client record.
Finding the Module Data in a Webhook Event
If your webhook endpoint is authorized, the event associated with a new booking will include additional data. The module data will be found in the JSON under eventContent.clientLinks[YOUR_MODULE_ID].metadata for the object matching the moduleId. If a booking has more than one client (i.e. group reservation) the Booxi clientId should also match.
clientLinks
[
ClientModuleLink
{
moduleId string
clientId integer
externalId string
metadata Metadata
{
A series of string key/value pairs that further describe this object.
These properties hold custom information about the object that is not directly
owned or used by Booxi. Metadata is commonly used to store merchant/partner
specific data (like an third party id) to the object to help with custom
integration.
ex. "loyaltyTier": "member"
}
createdOn string($date-time)
modifiedOn string($date-time)
}
]
Retrieving the Module Link Data
To retrieve the module data for a client, use the client API GET /client/{clientId}/moduleLink/{moduleId}/ by providing a Booxi clientId and moduleId.
Request URL for North America
https://api.booxi.com/booking/v1/client/{clientId}/moduleLink/{moduleId}
cURL
curl -X GET
"https://api.booxi.com/booking/v1/client/{clientId}/moduleLink/{moduleId}"
-H "accept: application/json"
-H "Booxi-PartnerKey: YOUR_PARTNER_KEY"
For North America | For Europe |
Updating the Module Link Data
To update the data, use the PUT /client/{clientId}/moduleLink/{moduleId}/ API by providing the Booxi clientId and moduleId associated with the entry you wish to update. Note that this operation will overwrite any previous data. It is recommended to copy the data before making any changes.
Request URL for North America
https://api.booxi.com/booking/v1/client/{clientId}/moduleLink/{moduleId}
cURL
curl -X PUT
"https://api.booxi.com/booking/v1/client/{clientId}/moduleLink/{moduleId}"
-H "accept: application/json"
-H "Booxi-PartnerKey: YOUR_PARTNER_KEY"
-d "{\"externalId\":\"{externalId}\",\"metadata\":{\"Your metadata here}}"
You can test this API at the following links.
For North America | For Europe |
CRM Synchronization Use Case
The following is provided as an example only. There are many different ways to approach the problem.
Listen to the webhook events to capture new appointment bookings (online and offline).
Check if the externalId found in the module link data matches one of your CRM customer Id.
If it matches, a returning customer booked an appointment. No changes are required in the Booxi client record but you might need to update your CRM entry.
If it doesn’t match, add a new customer in your CRM and use the client API to update the Booxi client record by setting its externalId.
Supported Modules
Cegid Y2
Client-specific module
Limitations
The authentication method requires a secure environment.
The endpoint must not be exposed on a webpage but rather server side.
The webhook endpoint must be configured/authorized to access a module.