{
  "opencollection": "1.0.0",
  "info": {
    "name": "Salesforce Sales Cloud Salesforce Analytics REST Change Events Event Schema API",
    "version": "59.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "authorization_code",
      "authorizationUrl": "https://login.salesforce.com/services/oauth2/authorize",
      "accessTokenUrl": "https://login.salesforce.com/services/oauth2/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Event Schema",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Salesforce Sales Cloud Get change event Avro schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{instance}.salesforce.com/services/data/v59.0/analytics/sobjects/:changeEventName/eventSchema",
            "params": [
              {
                "name": "changeEventName",
                "value": "",
                "type": "path",
                "description": "The change event API name (e.g., AccountChangeEvent for Account, Contact__ChangeEvent for a custom object)"
              },
              {
                "name": "payloadFormat",
                "value": "",
                "type": "query",
                "description": "The payload format for the schema"
              }
            ]
          },
          "docs": "Retrieves the Apache Avro schema for the specified change event. The schema defines the event message structure including header fields and object-specific data fields."
        },
        {
          "info": {
            "name": "Salesforce Sales Cloud Get event schema by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{instance}.salesforce.com/services/data/v59.0/analytics/event/eventSchema/:schemaId",
            "params": [
              {
                "name": "schemaId",
                "value": "",
                "type": "path",
                "description": "The schema ID from the change event message"
              },
              {
                "name": "payloadFormat",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves an event schema using the schema ID provided in a change event message. Useful when dynamically processing change events and needing to resolve the schema at runtime."
        },
        {
          "info": {
            "name": "Salesforce Sales Cloud Get platform event schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{instance}.salesforce.com/services/data/v59.0/analytics/sobjects/:eventApiName/eventSchema",
            "params": [
              {
                "name": "eventApiName",
                "value": "",
                "type": "path",
                "description": "The API name of the platform event (e.g., Order_Event__e)"
              },
              {
                "name": "payloadFormat",
                "value": "",
                "type": "query",
                "description": "The payload format for the schema"
              }
            ]
          },
          "docs": "Retrieves the Apache Avro schema for the specified platform event. The schema describes the event's fields and their types in Avro format, used by the Pub/Sub API for binary event encoding."
        }
      ]
    }
  ],
  "bundled": true
}