Skip to main content

Introduction

Explore the schemas/ folder, a pivotal component in defining the structure and functionality of your activity. This folder hosts a collection of schema files, each tailored to specific aspects of your integration's behavior and structure.

Folder Structure​

cloud_integration/
│
├── schemas/                       # Central repository for all schema files
│   ├── resources/                 # Stores schemas for individual resources
│   │   ├── resource1.jsonc        # Schema for the first resource
│   │   ├── resource2.jsonc        # Schema for the second resource
│   │   └── resource3.jsonc        # Schema for the third resource
│   │
│   ├── authentication.jsonc       # Outlines authentication mechanisms
│   ├── base.jsonc                 # Serves as a template for other schemas
│   ├── common_variables.jsonc     # Maintains common variables across schemas
│   ├── webhook.jsonc              # Manages webhook-related schemas
│
└── ...

Detailed Overview​

This folder is essential for ensuring that every functionality within your activity is well-defined and organized:

  • Resources Folder: The term Resourcerefers to entities such as accounts, contacts, deals, etc. The Resource parameter facilitates targeted operations within the activity, enabling you to manipulate specific data types effectively. The resources folder Contains schemas for each specific resource your integration deals with. These schemas define how each resource interacts with your system, ensuring tailored behavior and responses.

  • Base Schema (base.jsonc): Acts as the foundational schema that other schemas within the directory can extend.

    • Note: Every Activity/Trigger should have an authentication mechanism. Therefore, this file is mandatory for every activity.

  • Authentication Schema (authentication.jsonc): 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.

  • Common Variables Schema (common_variables.jsonc): Stores variables that are common across various schemas. This centralization simplifies modifications and ensures consistency throughout your schemas Coming Soon.

  • Webhook Schema (webhook.jsonc): Manages the configurations and definitions related to webhook events, crucial for integrations that rely on real-time data and actions.

Conclusion​

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 a high level of 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.