Salesforce Marketing Cloud REST API — Journeys

naftiko: 1.0.0-alpha2
info:
  label: Salesforce Marketing Cloud REST API — Journeys
  description: 'Salesforce Marketing Cloud REST API — Journeys. 3 operations. Lead operation: Fire a journey entry event.
    Self-contained Naftiko capability covering one Salesforce business surface.'
  tags:
  - Salesforce
  - Journeys
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SALESFORCE_API_KEY: SALESFORCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: marketing-cloud-rest-journeys
    baseUri: https://{subdomain}.rest.marketingcloudapis.com
    description: Salesforce Marketing Cloud REST API — Journeys business capability. Self-contained, no shared references.
    resources:
    - name: interaction-v1-events
      path: /interaction/v1/events
      operations:
      - name: firejourneyevent
        method: POST
        description: Fire a journey entry event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: interaction-v1-interactions
      path: /interaction/v1/interactions
      operations:
      - name: listjourneys
        method: GET
        description: List journeys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
          description: The page number to retrieve. Defaults to 1.
        - name: pageSize
          in: query
          type: integer
          description: The number of journeys to return per page. Defaults to 50.
        - name: status
          in: query
          type: string
          description: Filter journeys by status. Use Draft, Published, ScheduledToSend, Stopped, or Deleted.
    - name: interaction-v1-interactions-interactionId
      path: /interaction/v1/interactions/{interactionId}
      operations:
      - name: getjourney
        method: GET
        description: Get a journey by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: interactionId
          in: path
          type: string
          description: The unique ID of the journey (interaction) to retrieve.
          required: true
        - name: versionNumber
          in: query
          type: integer
          description: The version number of the journey to retrieve. If not specified, returns the latest version.
    authentication:
      type: bearer
      token: '{{env.SALESFORCE_API_KEY}}'
  exposes:
  - type: rest
    namespace: marketing-cloud-rest-journeys-rest
    port: 8080
    description: REST adapter for Salesforce Marketing Cloud REST API — Journeys. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/interaction/v1/events
      name: interaction-v1-events
      description: REST surface for interaction-v1-events.
      operations:
      - method: POST
        name: firejourneyevent
        description: Fire a journey entry event
        call: marketing-cloud-rest-journeys.firejourneyevent
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/interaction/v1/interactions
      name: interaction-v1-interactions
      description: REST surface for interaction-v1-interactions.
      operations:
      - method: GET
        name: listjourneys
        description: List journeys
        call: marketing-cloud-rest-journeys.listjourneys
        with:
          page: rest.page
          pageSize: rest.pageSize
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/interaction/v1/interactions/{interactionid}
      name: interaction-v1-interactions-interactionid
      description: REST surface for interaction-v1-interactions-interactionId.
      operations:
      - method: GET
        name: getjourney
        description: Get a journey by ID
        call: marketing-cloud-rest-journeys.getjourney
        with:
          interactionId: rest.interactionId
          versionNumber: rest.versionNumber
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: marketing-cloud-rest-journeys-mcp
    port: 9090
    transport: http
    description: MCP adapter for Salesforce Marketing Cloud REST API — Journeys. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: fire-journey-entry-event
      description: Fire a journey entry event
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: marketing-cloud-rest-journeys.firejourneyevent
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-journeys
      description: List journeys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketing-cloud-rest-journeys.listjourneys
      with:
        page: tools.page
        pageSize: tools.pageSize
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: get-journey-id
      description: Get a journey by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketing-cloud-rest-journeys.getjourney
      with:
        interactionId: tools.interactionId
        versionNumber: tools.versionNumber
      outputParameters:
      - type: object
        mapping: $.