Base Schema

The base.json file establishes the foundational configuration for API requests within your integration. It defines critical components such as authorization, parameter definitions, and error handling mechanisms. The base.json file is crucial for configuring and managing the initial settings of API interactions in your integration. It ensures that all operations are carried out with proper authorization and according to the defined parameters, enhancing the security and efficiency of your activity.

This enhanced format improves readability, organizes information clearly, and ensures that technical details are accessible and easy to understand, providing a comprehensive guide to the base configuration file in your activity documentation.

note

Every activity/trigger should have an authentication mechanism. Therefore, this file is mandatory for every activity.

{
    "parameters": [
        {
            "name": "secret",
            "meta": {
                "displayName": "Freshsales Account",
                "displayType": "autocomplete",
                "placeholder": "Select Freshsales Account",
                "description": "Freshsales is a secure partner with Boltic. Your credentials are encrypted & can be removed at any time.",
                "options": [],
                "config": {
                    "urlType": "secret",
                    "method": "get",
                    "url": "/FRESHSALES?current_page=1&page_size=999",
                    "labelKey": "name",
                    "valueKey": "_id"
                },
                "htmlProps": {
                    "showAddNew": true
                },
                "value": "",
                "validation": {
                    "required": true
                }
            }
        },
        {
            "name": "resource",
            "meta": {
                "displayName": "Resource",
                "displayType": "select",
                "placeholder": "Select a resource",
                "description": "Select the resource you want to work with.",
                "options": [
                    { "label": "Account", "value": "account" },
                    { "label": "Contact", "value": "contact" },
                    { "label": "Deal", "value": "deal" },
                    { "label": "Appointment", "value": "appointment" },
                    { "label": "Sales Activity", "value": "sales" },
                    { "label": "Note", "value": "note" },
                    { "label": "Task", "value": "task" },
                    { "label": "Custom", "value": "custom" }
                ],
                "value": "",
                "validation": {
                    "required": true
                },
                "dependencies": {
                    "conditions": [
                        {
                            "field": "secret",
                            "operator": "NOT_EMPTY"
                        }
                    ]
                }
            }
        }
    ]
}

Parameters Overview

1. Account/Secret Selection (secret): Enables users to authenticate and select the relevant account or secret necessary for the integration.

   note

   This field is typically the first one encountered when integrating with a CRM tool or service. it is used to authenticate the user.

2. Resource Selection (resource): Users can choose from various resources they wish to interact with, such as accounts, contacts, deals, etc. This parameter facilitates targeted operations within the integration.