Coveo Event API — Event API

naftiko: 1.0.0-alpha2
info:
  label: Coveo Event API — Event API
  description: 'Coveo Event API — Event API. 3 operations. Lead operation: Send Events to Coveo Analytics.. Self-contained
    Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Event
  - Event API
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: event-event-api
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Event API — Event API business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-events-v1
      path: /rest/organizations/{organizationId}/events/v1
      operations:
      - name: sendevents
        method: POST
        description: Send Events to Coveo Analytics.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-events-v1-requests-validate
      path: /rest/organizations/{organizationId}/events/v1/requests/validate
      operations:
      - name: validaterequest
        method: POST
        description: Validate Coveo API Requests.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: type
          in: query
          type: string
          description: The request type
          required: true
        - name: version
          in: query
          type: integer
          description: The API version
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-events-v1-validate
      path: /rest/organizations/{organizationId}/events/v1/validate
      operations:
      - name: validateevents
        method: POST
        description: Validate Events with Coveo Analytics.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: event-event-api-rest
    port: 8080
    description: REST adapter for Coveo Event API — Event API. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/events/v1
      name: rest-organizations-organizationid-events-v1
      description: REST surface for rest-organizations-organizationId-events-v1.
      operations:
      - method: POST
        name: sendevents
        description: Send Events to Coveo Analytics.
        call: event-event-api.sendevents
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/events/v1/requests/validate
      name: rest-organizations-organizationid-events-v1-requests-validate
      description: REST surface for rest-organizations-organizationId-events-v1-requests-validate.
      operations:
      - method: POST
        name: validaterequest
        description: Validate Coveo API Requests.
        call: event-event-api.validaterequest
        with:
          organizationId: rest.organizationId
          type: rest.type
          version: rest.version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/events/v1/validate
      name: rest-organizations-organizationid-events-v1-validate
      description: REST surface for rest-organizations-organizationId-events-v1-validate.
      operations:
      - method: POST
        name: validateevents
        description: Validate Events with Coveo Analytics.
        call: event-event-api.validateevents
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: event-event-api-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Event API — Event API. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: send-events-coveo-analytics
      description: Send Events to Coveo Analytics.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: event-event-api.sendevents
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-coveo-api-requests
      description: Validate Coveo API Requests.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: event-event-api.validaterequest
      with:
        organizationId: tools.organizationId
        type: tools.type
        version: tools.version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-events-coveo-analytics
      description: Validate Events with Coveo Analytics.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: event-event-api.validateevents
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.