Boilerplate Overview
Boilerplate is a pre-written codebase that speeds up development by providing a foundational template for building extensions.
Go through the steps in the Getting Started page to generate a boilerplate.
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.
| Component | Type | Description |
|---|---|---|
| Resource Directory | Folder | Defines schemas for specific entities, referred to as resources, such as accounts, contacts, deals, and more. |
| Authentication | authentication.json | Provides detailed definitions related to the authentication mechanisms of your integration. Each file in this folder defines how a particular resource should behave. |
| Base | base.json | Serves as the foundational schema for configuration and parameters. |
| Webhook | webhook.json | Manages the configurations and definitions related to webhook events, crucial for integrations that rely on real-time data and actions. |
| Documentation | Files | Explains the authentication process and operational overview of the integrations. |
| Specification | spec.js | Contains metadata about the specifications. |
Role of Integration Files in Triggers and Activities
In Boltic Workflows, users must select Triggers and Activities to define the execution flow. These Triggers and Activities are powered by Integrations, which are built using a specific file structure.
Each file plays a specific role, determining how the integration behaves, what configuration is needed, and how data flows through your workflow.
The table below shows the role of each file and identifies whether it contributes to Triggers, Activities, or both:
| File Name | Impacts |
|---|---|
| authentication.json | Triggers and Activities |
| webhook.json | Triggers |
| base.json | Activities |
| resources/ files | Activities |
| spec.json | Activities |