ProviderAppMetadata

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-schema/ampersand-api-provider-app-metadata-schema.json",
  "title": "ProviderAppMetadata",
  "description": "Provider-specific configuration that extends the standard OAuth flow.",
  "type": "object",
  "properties": {
    "authQueryParams": {
      "type": "object",
      "description": "Additional query parameters to include in the OAuth authorization URL (e.g., optional_scope for HubSpot).",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "example": {
        "optional_scope": [
          "automation.sequences.read"
        ]
      }
    },
    "providerParams": {
      "type": "object",
      "description": "Provider-specific string values keyed by names (e.g., packageInstallURL for Salesforce, gcpProjectId and gcpPubSubTopicName for Gmail).",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "packageInstallURL": "https://login.salesforce.com/packaging/installPackage.apexp?p0=04t123456789",
        "gcpProjectId": "my-gcp-project",
        "gcpPubSubTopicName": "my-topic"
      }
    }
  }
}