New Horizon Experience. This article describes the New Horizon Experience, which is available now. In the Horizon WebRef mobile apps for Android and iOS, New Horizon is already what you see. On a computer or laptop you see it when you are in New Horizon. If you still have the older layout, choose Try the New Horizon Experience from the banner or your account menu. You can switch back from that menu any time.
This article covers how organization administrators request a Developer API key from Developer API Settings in HorizonWebRef. You open that window from System Settings after you add the Developer API add-on.
It is for organization administrators who can open System Settings. Everyday members do not request a key from this page. Use this article when you want Horizon to issue credentials so you can call the Developer API, including a local test that has no public endpoint yet.
The Developer API is an optional add-on. Most organizations never need it. If you only need the everyday HorizonWebRef schedule and payroll tools, you can stop here.
How the Developer API works
The Developer API is a paid (or free-tier) add-on that lets a program you write talk to your HorizonWebRef organization. After Horizon issues a key, you return to Developer API Settings to see your Application ID and Application key, plus optional webhook and policy addresses.
A new key is not issued instantly. Horizon reviews each request. Issuing a key usually takes 1 to 10 business days. You will receive an email when a decision has been made. After the key is issued, come back to the same Settings window for any later changes.
For programming details after you have a key, start at the Developer API documentation. Related Help Center articles cover API rate limits and pricing, developer scopes, and available add-on services.
Turn on the Developer API add-on
Only an organization administrator can add this service. Sign in, then open System Settings. On Overview, open Add-Ons (the tile says Add-Ons, and the section heading is Add-on services). On a larger screen you can also choose Add-Ons in the settings sidebar.
On a computer, the same Overview uses tiles plus a left settings list. Add-Ons is the last tile in that grid.
Find the Developer API card. If your organization does not have the add-on yet, choose Add service. If it is already added, skip ahead to Settings.
On a computer, the Developer API card sits in the same Add-on services list.
Add service opens a window titled Add Service with Monthly pricing and Yearly pricing. Choose a package, then Subscribe. There is a FREE package for getting started, plus paid packages such as Mini, Bronze, Bronze+, Silver, Gold, Platinum, and Ultimate. Paid packages show a yearly total even when you compare Monthly pricing. After you choose Subscribe on the free package, confirm Free service with Add service. Paid packages open Non-refundable and ask you to choose I agree, add service before checkout.
On a computer, the same packages appear in a wider grid. Subscribe still sits on each package card.
When the add-on is active, the Developer API card shows Manage and Settings. Settings is the path to the key request.
Open Developer API Settings and request a key
On the Developer API card, choose Settings. A window titled Settings opens, with the heading Developer API Settings and the line Manage your API credentials, webhook endpoint, and delivery history.
Until a key is issued, you see the request form and Request API key. Fill the required fields first, then the optional ones if you have them.
On a computer, the same form uses two columns for some fields. Request API key stays at the bottom of the window.
Required fields
These fields must be complete before Horizon will accept the request:
Developer name - shown for you. For an organization request this is your organization name and is not a field you type.
Support email - a real email address Horizon can use about this developer account.
Website - the website where you will use the API. It must start with http:// or https://. It cannot include extra options after a question mark.
Please explain how you intend to use the API - write in full sentences and give as much detail as you can. The hint on the page says you need at least 50 characters.
Optional fields
These three are marked Optional. You can leave them blank and still send the request:
Webhook URL - only if you have a public address that can receive webhook deliveries. It must use https:// and include a path to a specific file or location, not just a home page.
Terms of Service URL - a specific terms page (for example a /terms page), not your home page.
Privacy Policy URL - a specific privacy page (for example a /privacy page), not your home page.
Each of those policy addresses must be different from your Website and from each other. If you only have a home page, leave the policy fields blank rather than repeating the same address.
If you will only use the API on your own computer
You can still request a key when the project will run only on a local computer and you do not have a public app address yet. Horizon still needs a Website on the form.
In Website, enter https://localhost. The form accepts that address. Do not add extra options after a question mark. That tells Horizon the work is on your own computer, not a public site.
Leave Webhook URL blank if you have no public address that can receive those deliveries. You can add a webhook later from the same Settings window after a key is issued.
In Please explain how you intend to use the API, say that you are testing locally and that there is no public endpoint yet. Write that in full sentences so the review has enough context (at least 50 characters).
If you skip Privacy Policy or Terms of Service
Those two URLs are optional, but skipping them limits what the API can do. If either field is blank when you choose Request API key, a Continue window explains that without that URL your developer API will be limited to only 1 access token. API calls may also be limited when those policy pages are not provided.
Choose Cancel if you can add the policy pages first. Choose Continue only if you understand the limit and still want to send the request. If you later publish real policy pages, return to Settings and save the specific /privacy and /terms addresses so Horizon can lift that limit.
After you send the request
When the request is accepted, the window changes to Awaiting approval... It says your API key request has been received, you will receive an email once a decision has been made, and you should return here for any future adjustments after a key is issued.
Review takes 1 to 10 business days. Watch the email address on your account (and the support email you entered). Do not send a second request while you are waiting. After Horizon issues the key, open Settings again to copy Application ID and Application key.
If the page says your request could not be sent, wait a few minutes and try again. If a field turns red, fix that field using the message under it (for example a website that includes extra options after a question mark, or an explanation shorter than 50 characters).
If you still see the older layout
On a computer or laptop, the older legacy layout stays until you choose Try the New Horizon Experience from the banner or your account menu. This article describes the New Horizon screen. Until that older layout is retired, look for the Developer API add-on on System Settings, then Settings, then Request API Key on that older form. Required fields are still Developer name, Support email, Website, and the explanation of how you intend to use the API. Optional fields are still Webhook URL, Terms of Service URL, and Privacy Policy URL.