Boilerplate Overview
Boilerplate is a pre-written codebase that speeds up development by providing a foundational template for building extensions.
If you do not have a boilerplate, please go through the steps in the Get Started page.
The folder name should match the Activity Name specified in the Activity form on the admin panel.
Directory Structure
├── schemas
│ ├── resources
│ │ └── resource1.json
│ ├── authentication.json
│ ├── base.json
│ └── webhook.json
├── Authentication.mdx
├── Documentation.mdx
└── spec.json
Schemas
The schemas/ folder is critical to your integration setup in Boltic CLI. It defines the structure, behavior, and functionality logic of your activity through a set of modular JSON schema files. This folder is essential for ensuring that every functionality within your activity is well-defined and organized. Understanding the schemas/ folder and its contents is crucial for effectively managing and enhancing your activity. This knowledge allows you to make informed updates, ensure consistency across your integration, and maintain high functionality as your system evolves. As you continue to build and refine your activity, keep this structured approach to manage and version your schemas effectively.
This format not only enhances the documentation's readability but also provides a comprehensive understanding of the importance and functionality of the schemas/ folder within your activity project.
Resources
The resources/ folder in the Boltic Integration boilerplate defines schemas for specific entities—referred to as resources—such as accounts, contacts, deals, and more. These resources represent the core data types your integration will interact with. By using the Resource parameter, you can enable targeted operations within an activity, allowing it to handle different types of data effectively. Each file in the resources/ folder defines how a particular resource should behave, including its structure, required fields, validation rules, and interaction patterns with external systems. This modular setup ensures that your integration logic is scalable and adaptable, allowing each resource to have tailored functionality and response handling.
Refer to Resource Directory for more details.
Base Schema
The base.json file serves as the foundational schema within the directory.
Every Activity/Trigger should have an authentication mechanism. Therefore, this file is mandatory for every activity.
Refer to Base Schema
Authentication Schema
The authentication.json files provides detailed definitions related to the authentication mechanisms of your integration. This schema ensures that all interactions with your cloud services are secure and verified.
Refer to Authentication Schema for more details.
Webhook Schema
The webhook.json file manages the configurations and definitions related to webhook events, crucial for integrations that rely on real-time data and actions.
Refer to Webhook Schema for more details.
Authentication Read Me File
The Authentication markdown file provides a human-readable documentation of the authentication mechanisms and their associated environment variables used to authorize API requests.
Documentation File
The Dcoumentation file offers a detailed description of the activity's flow and possible operations, providing comprehensive insights into its functionality.
Specification
The spec.json file contains metadata about the version and specifications of the activity, ensuring all users and systems interact with the correct version.