Configure API applications
An API application is the identity an external system uses to call the Zenoti API. Each application carries its own credentials (secrets and API keys), a scope that lists the endpoints it may call, and, for center-level applications, the centers it may reach. This article covers the Apps page: creating an application, scoping it, managing its credentials, linking centers, and reading the API developer dashboard.
On this page
- Before you begin
- External-system prerequisites
- Network requirements
- The Apps page
- Create an application
- Scope the application
- Manage credentials
- Link centers
- Delete an application
- Read the API developer dashboard
- Tips
- Troubleshooting
- Related articles
Before you begin
Permission: Manage Apps under Api in the Administrator section of the security role. Zenoti names this permission when a feature that depends on it is turned on without it:
To enable this feature, select Manage Apps role permission under Administrator section and try again.
- API access must be enabled for your organization. API access is turned on with the Zenoti API and Webhooks subscription; it is not a setting an administrator can switch on from Configuration. Without it the Apps row does not appear at all β see Troubleshooting.
- Decide which Zenoti endpoints the external system needs before you create the application. Scopes are easier to narrow at creation time than to widen later.
- Have a password vault or secret manager ready. Secrets and API keys are shown once, when they are generated.
External-system prerequisites
The application lives in Zenoti, but the consumer that uses it is an external system. Before you create the application, make sure the external side is ready:
- The consumer can store a secret or API key securely (environment variable, secret manager, vault), not in source code or browser-side JavaScript.
- The consumer team owns a runbook for key rotation. A rotated Zenoti key expires a week later; a consumer without a rotation plan breaks at that point.
- A named business owner for the integration exists. When that person leaves, the application must be audited and its credentials rotated.
For Zapier specifically, see Configure Zapier integration. For webhooks, see Configure webhooks and automation.
Network requirements
Zenoti's public API is served over HTTPS. There is no inbound port requirement on your side unless the external consumer also receives callbacks.
| Direction | Endpoint | Port | Purpose |
|---|---|---|---|
| Consumer β Zenoti | https://<your-tenant>.zenoti.com/api/... |
443 (HTTPS) | API calls from the consumer to Zenoti |
| Zenoti β Consumer (webhooks only) | Your webhook receiver URL | 443 (HTTPS) | Only if you also configure webhook subscriptions; see Configure webhooks and automation |
If your Zenoti tenant enforces IP allowlisting, allowlist the consumer's egress IP range.
The Apps page
Navigate to Configuration > Integrations > Apps. The Apps row appears under Integrations only when API access is on for your organization and your security role holds Manage Apps under Api. If either is missing, the row is hidden rather than shown with an error β so an absent Apps row is not by itself a permission problem. When no application exists yet, the Apps page shows Create Application Type with the text Create a new application for this organization., the button Add, and the link Create your first App. Once applications exist, the Manage Applications list shows each application's Name, Type, Description, Enabled state, and Level (Organization or Center); Dashboard opens the API Developer Dashboard, and Add starts a new application.
Select an application's name to open it. An existing application opens as Edit Application with the tabs General, Scope, Credentials, and Link Centers. A new application is created through the Create application wizard, which has three steps: 1 General, 2 Scope, and 3 Credentials.
Create an application
On the Apps page, select Add. Create application opens on step 1 General (the breadcrumb reads Integrations > Apps > Create application).
Complete the general details. Name, Login User Type, and App Type are marked as required.
Field What to enter Name (required) A label that names the consumer's business purpose, for example "HubSpot CRM Sync". Zenoti rejects an empty name with Application Name must be specified.Description What the consumer does, who owns it, and which endpoints it calls. Used for audit. App Type ExternalCMA, ExternalWebstore, ClientApp, or Bot, depending on what the consumer is. Login User Type (required) Guest or Employee: the kind of Zenoti user the application authenticates as. Zenoti rejects an empty value with LoginUserType must be specified.Source App The Zenoti application the consumer extends, where applicable. URI, Post Login Redirect Url, Post Logout Redirect Url For consumers that sign users in through Zenoti: the consumer's base URI and the addresses Zenoti redirects to after login and logout. Select Next. Correct anything the form marks in red (
Correct the errors marked in red before continuing) β an empty Name is the usual cause β then move through 2 Scope and 3 Credentials to complete the wizard (Cancel abandons it). The application receives an Application ID, shown on the Credentials tab.
Scope the application
The Scope tab lists the API endpoints the application may call, as endpoint groups. There are two independent lists: one for calls authenticated with a JWT, one for calls authenticated with an API key. Each list has a Select All check box, and each group row has a Select Data control that expands the group's Endpoint rows (route and HTTP verb) so you can see what it covers before granting it.
- Open the application and select the Scope tab.
- In the JWT Groups list, select the check box beside every group the consumer requires when it authenticates with a JWT.
- In the APIKey Groups list, do the same for API-key calls.
- Save.
The two lists are independent. Granting a group under JWT Groups does not grant it under APIKey Groups, and the reverse is equally true. Grant the group in the list that matches how the consumer actually authenticates.
Groups (Group Name) are named for the capability they unlock rather than for individual endpoints. If you are unsure which endpoints a consumer needs, ask the consumer's developer. Granting every group is a security-review finding.
Manage credentials
The Credentials tab holds the Application ID, the application's Secrets, and its API keys.
- Secrets. Select Create New to generate a secret. Zenoti warns:
This will delete your current secret and create a new one. NOTE : Please store the newly generated secret safely, it won't be displayed later.Copy the value to your vault before you leave the tab. - API keys. Select Generate API Key. Zenoti warns
This will create a new apikey. NOTE : Please store the newly generated apikey safely, it won't be displayed later.The key grid lists each Api Key with its Expiry Date; the newest key is labelled Latest Api Key, and the Private Api Key value is the one you copy. - Rotate. Select Rotate to issue a replacement key. Zenoti warns:
This will create a new apikey. Your latest apikey will expire in a week, please replace it with the new apikey before then.The week-long overlap is the rotation window: update the consumer, test, and let the old key lapse. - Remove. Select Remove beside a key to revoke it immediately (
Are you sure you want to REMOVE this ApiKey?). Removing the last key promptsYou are about to delete the last ApiKey in this Application. Please confirm before proceeding.
Plan a rotation:
- Coordinate a low-traffic window with the consumer owner.
- Select Rotate and copy the new key.
- Update the consumer's stored key within the week.
- Send a known request and confirm it succeeds.
- Let the old key expire, or Remove it once the consumer is confirmed on the new key.
Link centers
A center-level application reaches only the centers linked to it. Centers are linked after the application exists: the Link Centers tab belongs to the Edit Application view and is not a step of the Create application wizard.
- Open the application and select the Link Centers tab.
- In Select Center, select the check box beside each Center Name the consumer may reach, or Select All for every center.
- Save. A center-level application must keep at least one center:
You cannot save this state, atleast one center has to be associated to a center level App.
Use center-level applications when the consumer physically operates at one location and a compromise must not expose other centers, or when integration ownership is delegated to center managers.
Delete an application
Deleting removes the application and every credential with it; the keys cannot be restored. Zenoti asks Are you sure you want to DELETE this Application? before it proceeds. To pause access without deleting, remove the application's API keys instead and re-generate them when access should resume.
Read the API developer dashboard
Dashboard on the Apps page opens the API Developer Dashboard.
- Choose an application in Select Application.
- Choose a period: 30 Minutes, 1 Hour, 4 Hours, 6 Hours, 12 Hours, 1 Day, 4 Days, 7 Days, 15 Days, or Custom date with a Start date and End date, then Apply. The page confirms the range with
Showing data from (β¦) to (β¦). - Read the three charts, API Call Volume, API Error Volume, and API Median Latency, and the per-route grid with API Route, Verb, Call Volume, Error (%), Median Latency, and P95 Latency.
Use the dashboard after every new integration goes live to confirm the consumer is calling only the routes you granted, to spot noisy consumers, and to find applications that have gone quiet and can be retired.
Tips
- One application per consumer. Never share credentials across two external systems. If one is compromised, a shared key exposes both.
- Name applications for their business purpose, not their technology. "HubSpot CRM Sync" is easier to audit in six months than "App 3".
- Set a calendar reminder for rotation. Zenoti expires a rotated key after a week, but does not force rotation on its own.
- Remove keys before you delete. Removing the keys pauses access reversibly; deletion is permanent.
- Document the business owner in the Description field. The next administrator then knows who to ask before rotating or deleting.
Troubleshooting
| Symptom | Likely cause | Resolution |
|---|---|---|
| The Apps row is not in the Integrations menu at all, with no permission error | Either API access is not enabled for your organization, or your role lacks Manage Apps under Api. The row is hidden when either is missing, so the two look identical from the menu. | Check the permission on your role first. If the role already holds Manage Apps and the row is still absent, API access is not enabled for your organization β it is turned on with the Zenoti API and Webhooks subscription, not by an administrator. Contact Zenoti Support. |
The Apps page shows You do not have permission |
The signed-in user's role lacks Manage Apps under Api in the Administrator section for the center the session is working in. | Grant the permission on the role, or sign in as a user who has it. |
| Consumer receives 403 Forbidden on specific endpoints | The application's scope does not include the group that covers those endpoints, or it was granted in the other authentication list. | Open the Scope tab and grant the group in the list that matches how the consumer authenticates. |
| Consumer receives 401 Unauthorized on all requests | The key it uses was removed, or a rotated key passed its one-week expiry before the consumer switched. | Generate or rotate a key, copy it, and update the consumer. |
| Center-level application cannot reach a center | The center is not linked. | Add it on the Link Centers tab. |
You cannot save this state, atleast one center has to be associated to a center level App |
Every center was unlinked. | Keep at least one center linked, or delete the application. |
Dashboard shows No Data Available |
The application has made no calls in the selected period, or the wrong application is selected. | Widen the period or pick the right application in Select Application. |
| Consumer reports intermittent 429 Too Many Requests errors | The consumer is exceeding the API rate limit. | Reduce request frequency, add exponential backoff and caching, or contact Zenoti Support about limits. |