Welcome!

This comprehensive guide is designed to assist Kindly partners in utilizing the Kindly API and webhooks to their full potential. With the API, partners can effortlessly create and manage various entities such as users, managers, events (including shifts), groups, and more. By seamlessly integrating their applications and systems with Kindly, partners can automate work flows, enhance operational efficiency, and provide a superior experience to their users. To learn more about our terminology, click here.

In addition to the API, Kindly also provides a robust webhook system that enables real-time notifications and data updates. Webhooks allow partners to receive instant notifications whenever specific events or changes occur within the Kindly platform. By leveraging webhooks, partners can stay synchronized with the latest data and take immediate actions based on these updates.

To begin integrating with Kindly, partners will be provided with a unique API key that acts as an authentication mechanism for API calls. This API key must be included in the request header named APIKEY for every API call, ensuring secure and authorized access to the Kindly API endpoints. The integration process is straightforward, allowing partners to quickly get up and running with minimal effort.

Furthermore, partners can set up webhooks to receive notifications from Kindly whenever predefined events occur. By configuring the appropriate webhook URLs, partners can receive payloads containing relevant data, such as new user registrations, event updates, or shift changes. This real-time communication ensures that partners have the most up-to-date information and can respond promptly to any changes in the Kindly platform.

This documentation serves as your comprehensive reference, covering all aspects of the Kindly API and webhook system. It provides detailed information on the available API endpoints, their parameters, and the expected responses. Each API endpoint is accompanied by clear and concise explanations, making it easy for you to understand its purpose and usage.

In addition, we provide detailed instructions on setting up webhooks, including the events that can trigger notifications and the data formats in the payloads. By following the guidelines in this documentation, partners can configure their webhook endpoints to receive and process the relevant information seamlessly.

Throughout this documentation, we have taken great care to provide informative error code explanations. In case of incorrect data or issues during API calls, the Kindly API returns specific error codes, enabling you to quickly identify and troubleshoot any problems that may arise. These error code references will assist you in effectively handling exceptional cases and providing a smooth user experience.

Our dedicated support team is committed to assisting you throughout the integration process. Should you encounter any challenges or have questions regarding the Kindly API or webhooks, please don't hesitate to reach out. We are here to help you succeed in leveraging the full potential of the Kindly API and webhooks, unlocking new possibilities for your business.

Let's embark on this journey together and explore the vast capabilities of the Kindly API and webhooks. By harnessing their power, you can revolutionize your operations, streamline your workflows, and deliver exceptional experiences to your users. Get ready to unlock a world of opportunities with the Kindly API and webhooks!