Choose language

Developer Overview

The Developer page provides access to Shifton’s API documentation and developer tools for building custom integrations.


What Is This?

The Developer page is the starting point for technical integrations with Shifton. It contains three tabs: Overview, Webhooks, and Applications. The Overview tab gives you quick links to both the current and legacy API documentation, which you can use to build custom integrations, automate workflows, or connect Shifton with your internal tools.


Prerequisites

RequirementDetails
RoleOwner
KnowledgeBasic understanding of APIs and web development (or access to a developer who does)

Step-by-Step Instructions

Accessing the Developer Page

1
From the left sidebar, click Integrations.
2
Navigate to the Developer page.
3
You will see three tabs at the top: Overview, Webhooks, and Applications.

Using the Overview Tab

Shifton screenshot

The Overview tab displays links to Shifton’s API documentation:

LinkDescription
New documentationLinks to the current, up-to-date API documentation
Old documentationLinks to the legacy API documentation for older integrations
1
Click New documentation to open the current API reference in a new tab.
2
If you have an existing integration built on the older API, click Old documentation to access the legacy reference.

Navigating to Other Developer Tabs

From the Developer page, you can also access:

1
Webhooks
tab — Set up webhook endpoints to receive real-time event notifications from Shifton.
2
Applications
tab — Create and manage custom applications that integrate with Shifton.

These are covered in detail in their own articles.


Access Permissions

RoleView Developer PageAccess API DocsCreate Webhooks/Apps
OwnerYesYesYes
NoNoNo
ManagerNoNoNo
EmployeeNoNoNo

FAQ

Q: Do I need programming skills to use the Developer page?
A: The API documentation is designed for developers. If you are a non-technical manager, you can share the documentation links with your development team or IT department.

Q: Which API documentation should I use — new or old?
A: Use the New documentation for all new integrations. The Old documentation is provided for backward compatibility with existing integrations that were built on the legacy API.

Q: Is there a rate limit on the API?
A: Yes, API rate limits may apply. Refer to the API documentation for specific details about request limits and best practices.

Q: Can I test API calls without affecting live data?
A: Refer to the API documentation for information about test environments or sandbox modes, if available.


Possible Issues and Solutions

IssuePossible CauseSolution
Developer page not visible in sidebarYou do not have Owner roleAsk your account Owner to grant the appropriate role
Documentation link leads to an error pageTemporary service issueTry again later, or contact Shifton support
Not sure which API version to useWorking with an existing integrationCheck your current integration code for API endpoint URLs to determine which version it uses
API key not visibleKey may need to be generated firstFollow the instructions in the API documentation to generate an API key