m3ter API — Events

naftiko: 1.0.0-alpha2
info:
  label: m3ter API — Events
  description: 'm3ter API — Events. 4 operations. Lead operation: List EventResponse. Self-contained Naftiko capability covering
    one M3ter business surface.'
  tags:
  - M3ter
  - Events
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    M3TER_API_KEY: M3TER_API_KEY
capability:
  consumes:
  - type: http
    namespace: m3ter-events
    baseUri: https://api.m3ter.com
    description: m3ter API — Events business capability. Self-contained, no shared references.
    resources:
    - name: organizations-orgId-events
      path: /organizations/{orgId}/events
      operations:
      - name: listevents
        method: GET
        description: List EventResponse
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) of the Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: pageSize
          in: query
          type: integer
          description: The maximum number of Events to retrieve per page.
        - name: ids
          in: query
          type: array
          description: 'List of Event UUIDs to filter the results. '
        - name: notificationId
          in: query
          type: string
          description: Notification UUID to filter the results. Returns the Events that have triggered the Notification.
        - name: accountId
          in: query
          type: string
          description: The Account ID associated with the Event to filter the results. Returns the Events that have been generated
            for the Account.
        - name: eventType
          in: query
          type: string
          description: 'The category of Events to filter the results by. Options:'
        - name: notificationCode
          in: query
          type: string
          description: Short code of the Notification to filter the results. Returns the Events that have triggered the Notification.
        - name: includeActioned
          in: query
          type: boolean
          description: A Boolean flag indicating whether to return Events that have been actioned.
        - name: nextToken
          in: query
          type: string
          description: The `nextToken` for multi-page retrievals. It is used to fetch the next page of Events in a paginated
            list.
        - name: eventName
          in: query
          type: string
        - name: resourceId
          in: query
          type: string
    - name: organizations-orgId-events-fields
      path: /organizations/{orgId}/events/fields
      operations:
      - name: listeventfields
        method: GET
        description: List Events
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: eventName
          in: query
          type: string
          description: The name of the specific Event Type to use as a list filter, for example `configuration.commitment.created`.
    - name: organizations-orgId-events-types
      path: /organizations/{orgId}/events/types
      operations:
      - name: listeventtypes
        method: GET
        description: List Notification Events
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifer (UUID) of the Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
    - name: organizations-orgId-events-id
      path: /organizations/{orgId}/events/{id}
      operations:
      - name: getevent
        method: GET
        description: Retrieve EventResponse
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: id
          in: path
          type: string
          description: The unique identifier (UUID) of the Event to retrieve.
          required: true
    authentication:
      type: bearer
      token: '{{env.M3TER_API_KEY}}'
  exposes:
  - type: rest
    namespace: m3ter-events-rest
    port: 8080
    description: REST adapter for m3ter API — Events. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/organizations/{orgid}/events
      name: organizations-orgid-events
      description: REST surface for organizations-orgId-events.
      operations:
      - method: GET
        name: listevents
        description: List EventResponse
        call: m3ter-events.listevents
        with:
          orgId: rest.orgId
          pageSize: rest.pageSize
          ids: rest.ids
          notificationId: rest.notificationId
          accountId: rest.accountId
          eventType: rest.eventType
          notificationCode: rest.notificationCode
          includeActioned: rest.includeActioned
          nextToken: rest.nextToken
          eventName: rest.eventName
          resourceId: rest.resourceId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/events/fields
      name: organizations-orgid-events-fields
      description: REST surface for organizations-orgId-events-fields.
      operations:
      - method: GET
        name: listeventfields
        description: List Events
        call: m3ter-events.listeventfields
        with:
          orgId: rest.orgId
          eventName: rest.eventName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/events/types
      name: organizations-orgid-events-types
      description: REST surface for organizations-orgId-events-types.
      operations:
      - method: GET
        name: listeventtypes
        description: List Notification Events
        call: m3ter-events.listeventtypes
        with:
          orgId: rest.orgId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/events/{id}
      name: organizations-orgid-events-id
      description: REST surface for organizations-orgId-events-id.
      operations:
      - method: GET
        name: getevent
        description: Retrieve EventResponse
        call: m3ter-events.getevent
        with:
          orgId: rest.orgId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: m3ter-events-mcp
    port: 9090
    transport: http
    description: MCP adapter for m3ter API — Events. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-eventresponse
      description: List EventResponse
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-events.listevents
      with:
        orgId: tools.orgId
        pageSize: tools.pageSize
        ids: tools.ids
        notificationId: tools.notificationId
        accountId: tools.accountId
        eventType: tools.eventType
        notificationCode: tools.notificationCode
        includeActioned: tools.includeActioned
        nextToken: tools.nextToken
        eventName: tools.eventName
        resourceId: tools.resourceId
      outputParameters:
      - type: object
        mapping: $.
    - name: list-events
      description: List Events
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-events.listeventfields
      with:
        orgId: tools.orgId
        eventName: tools.eventName
      outputParameters:
      - type: object
        mapping: $.
    - name: list-notification-events
      description: List Notification Events
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-events.listeventtypes
      with:
        orgId: tools.orgId
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-eventresponse
      description: Retrieve EventResponse
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-events.getevent
      with:
        orgId: tools.orgId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.