openapi: 3.1.0
info:
  title: Salesforce Analytics (CRM Analytics) REST Actions Change Events API
  description: REST API for accessing and managing CRM Analytics (formerly Tableau CRM / Einstein Analytics) resources including datasets, lenses, dashboards, and dataflows. Enables programmatic access to analytics metadata, query execution, and dashboard management. Uses the Wave API resource at /services/data/vXX.0/wave.
  version: '63.0'
  contact:
    name: Salesforce Developer Support
    url: https://developer.salesforce.com/support
    email: developer@salesforce.com
  license:
    name: Salesforce API Terms of Use
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v63.0/wave
  description: Salesforce production or developer instance
  variables:
    instance:
      default: yourInstance
      description: Your Salesforce instance identifier
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Change Events
  description: Change Data Capture event metadata and schema
paths:
  /sobjects/{changeEventName}:
    get:
      operationId: describeChangeEvent
      summary: Describe a Change Data Capture event
      description: Returns metadata about a Change Data Capture event type. Change event names follow the pattern {SObjectName}ChangeEvent (e.g., AccountChangeEvent, ContactChangeEvent) for standard objects, or {CustomObjectName}__ChangeEvent for custom objects.
      tags:
      - Change Events
      parameters:
      - name: changeEventName
        in: path
        required: true
        description: The API name of the Change Data Capture event (e.g., AccountChangeEvent, ContactChangeEvent, MyObject__ChangeEvent)
        schema:
          type: string
          pattern: .*ChangeEvent$
      responses:
        '200':
          description: Change event metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeEventDescribe'
  /sobjects/{changeEventName}/describe:
    get:
      operationId: describeChangeEventFull
      summary: Get full Change Data Capture event describe
      description: Returns complete metadata for a CDC event type including all available change event fields and their properties.
      tags:
      - Change Events
      parameters:
      - name: changeEventName
        in: path
        required: true
        schema:
          type: string
          pattern: .*ChangeEvent$
      responses:
        '200':
          description: Full change event describe
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeEventDescribe'
  /sobjects/{changeEventName}/eventSchema:
    get:
      operationId: getChangeEventSchema
      summary: Get the Avro schema for a Change Data Capture event
      description: Returns the Apache Avro schema for a Change Data Capture event channel, used by the Pub/Sub API.
      tags:
      - Change Events
      parameters:
      - name: changeEventName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Change event Avro schema
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
components:
  schemas:
    ChangeEventDescribe:
      type: object
      properties:
        name:
          type: string
          description: The API name of the change event (e.g., AccountChangeEvent)
        label:
          type: string
        labelPlural:
          type: string
        fields:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              label:
                type: string
              type:
                type: string
              nillable:
                type: boolean
        associateEntityType:
          type:
          - string
          - 'null'
          description: The associated entity type (ChangeEvent)
        associateParentEntity:
          type: string
          description: The parent SObject type that this change event tracks (e.g., Account, Contact)
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.salesforce.com/services/oauth2/authorize
          tokenUrl: https://login.salesforce.com/services/oauth2/token
          scopes:
            api: Access and manage your Salesforce data
            wave_api: Access CRM Analytics REST API resources
    bearerAuth:
      type: http
      scheme: bearer