Salesforce Sales Cloud Salesforce Platform Events API — Platform Events

naftiko: 1.0.0-alpha2
info:
  label: Salesforce Sales Cloud Salesforce Platform Events API — Platform Events
  description: 'Salesforce Sales Cloud Salesforce Platform Events API — Platform Events. 3 operations. Lead operation: Salesforce
    Sales Cloud Describe a platform event. Self-contained Naftiko capability covering one Salesforce Sales Cloud business
    surface.'
  tags:
  - Salesforce Sales Cloud
  - Platform Events
  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-platform-events
    baseUri: https://{instance}.salesforce.com/services/data/v59.0
    description: Salesforce Sales Cloud Salesforce Platform Events API — Platform Events business capability. Self-contained,
      no shared references.
    resources:
    - name: sobjects-eventApiName
      path: /sobjects/{eventApiName}
      operations:
      - name: describeplatformevent
        method: GET
        description: Salesforce Sales Cloud Describe a platform event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: publishplatformevent
        method: POST
        description: Salesforce Sales Cloud Publish a platform event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sobjects-eventApiName-describe
      path: /sobjects/{eventApiName}/describe
      operations:
      - name: describeplatformeventfull
        method: GET
        description: Salesforce Sales Cloud Get full platform event metadata
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.SALESFORCE_SALES_CLOUD_API_KEY}}'
  exposes:
  - type: rest
    namespace: platform-events-platform-events-rest
    port: 8080
    description: REST adapter for Salesforce Sales Cloud Salesforce Platform Events API — Platform Events. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/sobjects/{eventapiname}
      name: sobjects-eventapiname
      description: REST surface for sobjects-eventApiName.
      operations:
      - method: GET
        name: describeplatformevent
        description: Salesforce Sales Cloud Describe a platform event
        call: platform-events-platform-events.describeplatformevent
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: publishplatformevent
        description: Salesforce Sales Cloud Publish a platform event
        call: platform-events-platform-events.publishplatformevent
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sobjects/{eventapiname}/describe
      name: sobjects-eventapiname-describe
      description: REST surface for sobjects-eventApiName-describe.
      operations:
      - method: GET
        name: describeplatformeventfull
        description: Salesforce Sales Cloud Get full platform event metadata
        call: platform-events-platform-events.describeplatformeventfull
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-events-platform-events-mcp
    port: 9090
    transport: http
    description: MCP adapter for Salesforce Sales Cloud Salesforce Platform Events API — Platform Events. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: salesforce-sales-cloud-describe-platform
      description: Salesforce Sales Cloud Describe a platform event
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-events-platform-events.describeplatformevent
      outputParameters:
      - type: object
        mapping: $.
    - name: salesforce-sales-cloud-publish-platform
      description: Salesforce Sales Cloud Publish a platform event
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-events-platform-events.publishplatformevent
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: salesforce-sales-cloud-get-full
      description: Salesforce Sales Cloud Get full platform event metadata
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-events-platform-events.describeplatformeventfull
      outputParameters:
      - type: object
        mapping: $.