Configure custom API sources
Custom sources let you identify the origin of bookings created through your API integrations. When a booking is created through an external application, Zenoti tags it with a source identifier so you can track where bookings come from in reports and on the appointment book.
Before you begin
- You need a backend application created in Zenoti with an API key. See Set up API authentication.
- Contact your Zenoti Customer Service Manager to obtain credentials for custom source configuration.
Permission: Manage API Keys, Manage Apps, and Manage Automation (under Administrator) -- Required to create backend applications and generate API keys.
How custom sources work
Zenoti supports four primary booking sources:
| Source | Identifier | Description |
|---|---|---|
| Consumer Mobile App | External-CMA | Bookings from a consumer-facing mobile application |
| Webstore | External-Webstore | Bookings from an external Webstore or online booking platform |
| Client App | Client App | Bookings from a client application |
| Bot | Bot | Bookings from an automated bot or chatbot |
When your application makes a booking API call, Zenoti automatically maps the API key to the corresponding source. The source icon appears on the appointment block in Zenoti Web and in reports, so staff can identify how each booking was made.
Steps
Set up a custom source
- Create a backend application in Zenoti and obtain the App ID, App Secret, and API Key.
- Include the API key in the
Authorizationheader of your booking API calls. - Zenoti automatically maps API calls to the corresponding source (External-Webstore, External-CMA, or Bot) based on the backend application configuration.
- Optionally, add bearer token authentication for additional security.
Verify source tagging
After creating a booking through your API integration:
- Open the Zenoti Web appointment book.
- Locate the appointment created by your integration.
- Check that the source icon on the appointment block matches your configured source.
- Run a bookings report and filter by source to confirm the booking appears under the correct source category.
Tips
- Use separate backend applications for each integration channel (for example, one for your Webstore and another for your mobile app) so you can track bookings by source.
- Source icons provide a quick visual indicator for front desk staff to identify how a booking was made.