@unito/integration-cli/dist/schemas/configuration.json

Integration CLI

{
  "$id": "https://unito.io/integration_cli/configuration.schema.json",
  "title": "Configuration",
  "type": "object",
  "description": "The configuration of an integration",
  "additionalProperties": false,
  "required": ["name"],
  "properties": {
    "name": {
      "type": "string",
      "pattern": "^[a-z0-9_-]+$",
      "description": "The name of the integration"
    },
    "baseUrl": {
      "type": "string",
      "description": "The base URL where the integration is located",
      "default": ""
    },
    "graphRelativeUrl": {
      "type": "string",
      "description": "The relative URL (to the baseUrl) where the graph of items of the integration is located",
      "default": "/"
    },
    "credentialAccountRelativeUrl": {
      "type": "string",
      "description": "The relative URL (to the baseUrl) to fetch the current integration's authenticated user",
      "default": "/me"
    },
    "webhookParsingRelativeUrl": {
      "type": ["string", "null"],
      "description": "The relative URL (to the baseUrl) to parse a webhook payload"
    },
    "webhookSubscriptionsRelativeUrl": {
      "type": ["string", "null"],
      "description": "The relative URL (to the baseUrl) to operate on webhook subscriptions"
    },
    "webhookAcknowledgeRelativeUrl": {
      "type": ["string", "null"],
      "description": "The relative URL (to the baseUrl) to acknowledge webhook sender"
    },
    "ui": {
      "type": "object",
      "description": "The UI-related information of the integration",
      "additionalProperties": false,
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The name of the integration, as it should be displayed in a UI"
        },
        "logo": {
          "type": "string",
          "description": "Base64-encoded SVG of the logo of the integration"
        }
      }
    },
    "authorizations": {
      "type": "array",
      "description": "The authorizations of the integration",
      "items": {
        "$ref": "https://unito.io/integration_cli/authorization.schema.json"
      }
    },
    "testAccounts": {
      "type": "object",
      "description": "The test accounts of the integration",
      "additionalProperties": false,
      "properties": {
        "development": {
          "type": "object",
          "description": "Test account for local development",
          "additionalProperties": true
        },
        "compliance": {
          "type": "object",
          "description": "Test account for compliance tests",
          "additionalProperties": true
        }
      }
    },
    "secrets": {
      "type": "object",
      "description": "The secrets of the integration",
      "additionalProperties": {
        "type": "string",
        "pattern": "^unito-secret-v[0-9]+:\/\/.*$"
      }
    },
    "environmentVariables": {
      "type": "object",
      "description": "The environment variables of the integration",
      "patternProperties": {
        "^[A-Z0-9_]+$": {
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  }
}