Skip to main content

Folder Structure Explanation

cloud_integration/                 # Folder Name
│
├── schemas/                       # Folder to hold schema files for different functionalities
│   ├── resources/                 # Subfolder for resource schemas
│   │   ├── resource1.jsonc        # JSONC file for resource 1
│   │   ├── resource2.jsonc        # JSONC file for resource 2
│   │   └── resource3.jsonc        # JSONC file for resource 3
│   │
│   ├── authentication.jsonc       # Authentication schema
│   ├── base.jsonc                 # Base schema that other schemas can extend
│   ├── common_variables.jsonc     # Schema for storing common variables
│   ├── webhook.jsonc              # Webhook schema for handling webhook events
│
├── authentication.mdx             # Authentication documentation
├── documentation.mdx              # General documentation for the integration
├── README.md                      # Project README file
└── spec.jsonc                     # Specification schema for integration

Here is the purpose and function of each of the folders within the activity folder structure, to help you better understand this paradigm.

cloud_integration/​

This is the root directory for your activity and serves as the primary folder name.

Note: The folder name should match the Activity Name specified in the Activity form on the admin panel.

Inside this root directory, you'll find several key files and directories:

  • Authentication.mdx: Provides a human-readable documentation of the authentication mechanisms and their associated environment variables used to authorize API requests.

  • Documentation.mdx: Offers a detailed description of the activity's flow and possible operations, providing comprehensive insights into its functionality.

  • README.md: A markdown file that includes extensive documentation of the activity, useful for developers and users needing detailed information about the integration.

  • spec.json: Contains metadata about the version and specifications of the activity, ensuring all users and systems interact with the correct version.

Next, Explore the schemas/ Folder.