Connections schema

schema.json

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Connection Details",
    "type": "object",
    "properties": {
        "$schema": {
            "type": "string",
            "description": "The schema to use when validating this JSON.",
            "example": "http://json-schema.org/draft-07/schema#"
        },
        "label": {
            "type": "string",
            "description": "The label for the integration.",
            "example": "Ontraport"
        },
        "slug": {
            "type": "string",
            "description": "A URL-friendly version of the label.",
            "example": "ontraport"
        },
        "main_file": {
            "type": "string",
            "description": "The main file associated with the integration.",
            "default": "plugin",
            "example": "noptin-ontraport"
        },
        "integration_description": {
            "type": "string",
            "description": "A description of the integration.",
            "example": "Ontraport is an all-in-one business automation platform that offers tools for CRM, email marketing, e-commerce, and task automation to help businesses manage customer relationships, streamline operations, and enhance marketing efforts."
        },
        "icon_id": {
            "type": "integer",
            "description": "The ID of the icon.",
            "example": 14302
        },
        "icon_url": {
            "type": "string",
            "description": "The URL of the icon.",
            "example": "https://noptin.com/wp-content/uploads/2023/04/ontraport-badge-64x64.png"
        },
        "brand_color": {
            "type": "string",
            "description": "The hex code for the brand color.",
            "example": "#1285ff"
        },
        "url": {
            "type": "string",
            "description": "The URL for the integration's website.",
            "example": "https://ontraport.com/"
        },
        "subscriber": {
            "type": "string",
            "description": "The singular term for a subscriber.",
            "example": "Contact"
        },
        "Subscribers": {
            "type": "string",
            "description": "The plural term for subscribers.",
            "example": "Contacts"
        },
        "has_universal_contacts": {
            "type": "boolean",
            "description": "Indicates if the integration has universal contacts support.",
            "example": true
        },
        "can_add_subscriber": {
            "type": "boolean",
            "description": "Indicates if the integration can add subscribers without specifying lists.",
            "example": true
        },
        "can_remove_subscriber": {
            "type": "boolean",
            "description": "Indicates if the integration can remove subscribers without specifying lists.",
            "example": true
        },
        "can_delete_subscriber": {
            "type": "boolean",
            "description": "Indicates if the integration can delete subscribers without specifying lists.",
            "example": true
        },
        "can_unsubscribe_subscriber": {
            "type": "boolean",
            "description": "Indicates if the integration can unsubscribe subscribers without specifying lists.",
            "example": true
        },
        "can_bulk_email": {
            "type": "boolean",
            "description": "Indicates if the integration can bulk email subscribers.",
            "example": true,
            "default": false
        },
        "lists": {
            "type": "object",
            "description": "Contains information about available list types.",
            "properties": {},
            "additionalProperties": {
                "type": "object",
                "description": "Contains details for a specific list type.",
                "properties": {
                    "label": {
                        "type": "string",
                        "description": "The label for the list type.",
                        "example": "Tag"
                    },
                    "plural_label": {
                        "type": "string",
                        "description": "The plural label for the list type.",
                        "example": "Tags"
                    },
                    "is_taggy": {
                        "type": "boolean",
                        "description": "Indicates if the list type is related to tags.",
                        "example": true
                    },
                    "is_default": {
                        "type": "boolean",
                        "description": "Indicates if the list type is the default one.",
                        "example": true
                    },
                    "is_dynamic": {
                        "type": "boolean",
                        "description": "Indicates if the list type is dynamic.",
                        "example": true
                    },
                    "can_add_subscriber": {
                        "type": "boolean",
                        "description": "Indicates if the list type can add subscribers.",
                        "example": true
                    },
                    "can_remove_subscriber": {
                        "type": "boolean",
                        "description": "Indicates if the list type can remove subscribers.",
                        "example": true
                    },
                    "can_filter_campaigns": {
                        "type": "boolean",
                        "description": "Indicates if the list type can filter campaigns.",
                        "example": true
                    },
                    "parent_id": {
                        "type": "string",
                        "description": "The ID of the parent list type."
                    }
                },
                "required": [
                    "label",
                    "plural_label"
                ]
            }
        }
    },
    "additionalProperties": false,
    "required": [
        "label",
        "slug",
        "main_file",
        "integration_description",
        "icon_id",
        "icon_url",
        "brand_color",
        "url",
        "subscriber",
        "Subscribers",
        "lists"
    ]
}