Iterable REST API — Workflows

naftiko: 1.0.0-alpha2
info:
  label: Iterable REST API — Workflows
  description: 'Iterable REST API — Workflows. 1 operations. Lead operation: Trigger a workflow. Self-contained Naftiko capability
    covering one Iterable business surface.'
  tags:
  - Iterable
  - Workflows
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ITERABLE_API_KEY: ITERABLE_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-workflows
    baseUri: https://api.iterable.com/api
    description: Iterable REST API — Workflows business capability. Self-contained, no shared references.
    resources:
    - name: workflows-triggerWorkflow
      path: /workflows/triggerWorkflow
      operations:
      - name: triggerworkflow
        method: POST
        description: Trigger a workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: Api-Key
      value: '{{env.ITERABLE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-workflows-rest
    port: 8080
    description: REST adapter for Iterable REST API — Workflows. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/workflows/triggerworkflow
      name: workflows-triggerworkflow
      description: REST surface for workflows-triggerWorkflow.
      operations:
      - method: POST
        name: triggerworkflow
        description: Trigger a workflow
        call: rest-workflows.triggerworkflow
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-workflows-mcp
    port: 9090
    transport: http
    description: MCP adapter for Iterable REST API — Workflows. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: trigger-workflow
      description: Trigger a workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-workflows.triggerworkflow
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.