Salesforce Sales Cloud Salesforce Platform Events API — Event Schema

naftiko: 1.0.0-alpha2
info:
  label: Salesforce Sales Cloud Salesforce Platform Events API — Event Schema
  description: 'Salesforce Sales Cloud Salesforce Platform Events API — Event Schema. 2 operations. Lead operation: Salesforce
    Sales Cloud Get event schema by schema ID. Self-contained Naftiko capability covering one Salesforce Sales Cloud business
    surface.'
  tags:
  - Salesforce Sales Cloud
  - Event Schema
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SALESFORCE_SALES_CLOUD_API_KEY: SALESFORCE_SALES_CLOUD_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-events-event-schema
    baseUri: https://{instance}.salesforce.com/services/data/v59.0
    description: Salesforce Sales Cloud Salesforce Platform Events API — Event Schema business capability. Self-contained,
      no shared references.
    resources:
    - name: event-eventSchema-schemaId
      path: /event/eventSchema/{schemaId}
      operations:
      - name: geteventschemabyid
        method: GET
        description: Salesforce Sales Cloud Get event schema by schema ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: schemaId
          in: path
          type: string
          description: The schema ID from the event message
          required: true
        - name: payloadFormat
          in: query
          type: string
          description: The payload format
    - name: sobjects-eventApiName-eventSchema
      path: /sobjects/{eventApiName}/eventSchema
      operations:
      - name: getplatformeventschema
        method: GET
        description: Salesforce Sales Cloud Get platform event schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: payloadFormat
          in: query
          type: string
          description: The payload format for the schema
    authentication:
      type: bearer
      token: '{{env.SALESFORCE_SALES_CLOUD_API_KEY}}'
  exposes:
  - type: rest
    namespace: platform-events-event-schema-rest
    port: 8080
    description: REST adapter for Salesforce Sales Cloud Salesforce Platform Events API — Event Schema. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/event/eventschema/{schemaid}
      name: event-eventschema-schemaid
      description: REST surface for event-eventSchema-schemaId.
      operations:
      - method: GET
        name: geteventschemabyid
        description: Salesforce Sales Cloud Get event schema by schema ID
        call: platform-events-event-schema.geteventschemabyid
        with:
          schemaId: rest.schemaId
          payloadFormat: rest.payloadFormat
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sobjects/{eventapiname}/eventschema
      name: sobjects-eventapiname-eventschema
      description: REST surface for sobjects-eventApiName-eventSchema.
      operations:
      - method: GET
        name: getplatformeventschema
        description: Salesforce Sales Cloud Get platform event schema
        call: platform-events-event-schema.getplatformeventschema
        with:
          payloadFormat: rest.payloadFormat
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-events-event-schema-mcp
    port: 9090
    transport: http
    description: MCP adapter for Salesforce Sales Cloud Salesforce Platform Events API — Event Schema. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: salesforce-sales-cloud-get-event
      description: Salesforce Sales Cloud Get event schema by schema ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-events-event-schema.geteventschemabyid
      with:
        schemaId: tools.schemaId
        payloadFormat: tools.payloadFormat
      outputParameters:
      - type: object
        mapping: $.
    - name: salesforce-sales-cloud-get-platform
      description: Salesforce Sales Cloud Get platform event schema
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-events-event-schema.getplatformeventschema
      with:
        payloadFormat: tools.payloadFormat
      outputParameters:
      - type: object
        mapping: $.