API Reference — subpackage_automationJourneys

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_automationJourneys
  description: 'API Reference — subpackage_automationJourneys. 3 operations. Lead operation: Add subscription to an automation
    <Badge intent="info" minimal outlined>OAuth Scope: automations:write</Badge>. Self-contained Naftiko capability covering
    one Beehiiv business surface.'
  tags:
  - Beehiiv
  - subpackage_automationJourneys
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BEEHIIV_API_KEY: BEEHIIV_API_KEY
capability:
  consumes:
  - type: http
    namespace: beehiiv-subpackage-automationjourneys
    baseUri: https://api.beehiiv.com/v2
    description: API Reference — subpackage_automationJourneys business capability. Self-contained, no shared references.
    resources:
    - name: publications-publicationId-automations-automationId-journeys
      path: /publications/{publicationId}/automations/{automationId}/journeys
      operations:
      - name: create
        method: POST
        description: 'Add subscription to an automation <Badge intent="info" minimal outlined>OAuth Scope: automations:write</Badge>'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: publicationId
          in: path
          type: string
          description: The prefixed ID of the publication object
          required: true
        - name: automationId
          in: path
          type: string
          description: The prefixed ID of the automation object
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: index
        method: GET
        description: 'List automation journeys <Badge intent="info" minimal outlined>OAuth Scope: automations:read</Badge>'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: publicationId
          in: path
          type: string
          description: The prefixed ID of the publication object
          required: true
        - name: automationId
          in: path
          type: string
          description: The prefixed ID of the automation object
          required: true
        - name: status
          in: query
          type: string
          description: Optionally filter the results by the automation journey's status.
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default
            is 10.
        - name: page
          in: query
          type: integer
          description: 'Pagination returns the results in pages. Each page contains the number of results specified by the
            `limit` (default: 10).'
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
    - name: publications-publicationId-automations-automationId-journeys-automationJourneyId
      path: /publications/{publicationId}/automations/{automationId}/journeys/{automationJourneyId}
      operations:
      - name: show
        method: GET
        description: 'Get automation journey <Badge intent="info" minimal outlined>OAuth Scope: automations:read</Badge>'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: publicationId
          in: path
          type: string
          description: The prefixed ID of the publication object
          required: true
        - name: automationId
          in: path
          type: string
          description: The prefixed ID of the automation object
          required: true
        - name: automationJourneyId
          in: path
          type: string
          description: The prefixed automation journey id
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
    authentication:
      type: bearer
      token: '{{env.BEEHIIV_API_KEY}}'
  exposes:
  - type: rest
    namespace: beehiiv-subpackage-automationjourneys-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_automationJourneys. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/publications/{publicationid}/automations/{automationid}/journeys
      name: publications-publicationid-automations-automationid-journeys
      description: REST surface for publications-publicationId-automations-automationId-journeys.
      operations:
      - method: POST
        name: create
        description: 'Add subscription to an automation <Badge intent="info" minimal outlined>OAuth Scope: automations:write</Badge>'
        call: beehiiv-subpackage-automationjourneys.create
        with:
          publicationId: rest.publicationId
          automationId: rest.automationId
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: index
        description: 'List automation journeys <Badge intent="info" minimal outlined>OAuth Scope: automations:read</Badge>'
        call: beehiiv-subpackage-automationjourneys.index
        with:
          publicationId: rest.publicationId
          automationId: rest.automationId
          status: rest.status
          limit: rest.limit
          page: rest.page
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/publications/{publicationid}/automations/{automationid}/journeys/{automationjourneyid}
      name: publications-publicationid-automations-automationid-journeys-automationjourneyid
      description: REST surface for publications-publicationId-automations-automationId-journeys-automationJourneyId.
      operations:
      - method: GET
        name: show
        description: 'Get automation journey <Badge intent="info" minimal outlined>OAuth Scope: automations:read</Badge>'
        call: beehiiv-subpackage-automationjourneys.show
        with:
          publicationId: rest.publicationId
          automationId: rest.automationId
          automationJourneyId: rest.automationJourneyId
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: beehiiv-subpackage-automationjourneys-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_automationJourneys. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: add-subscription-automation-badge-intent-info
      description: 'Add subscription to an automation <Badge intent="info" minimal outlined>OAuth Scope: automations:write</Badge>'
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: beehiiv-subpackage-automationjourneys.create
      with:
        publicationId: tools.publicationId
        automationId: tools.automationId
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-automation-journeys-badge-intent-info
      description: 'List automation journeys <Badge intent="info" minimal outlined>OAuth Scope: automations:read</Badge>'
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: beehiiv-subpackage-automationjourneys.index
      with:
        publicationId: tools.publicationId
        automationId: tools.automationId
        status: tools.status
        limit: tools.limit
        page: tools.page
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-automation-journey-badge-intent-info
      description: 'Get automation journey <Badge intent="info" minimal outlined>OAuth Scope: automations:read</Badge>'
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: beehiiv-subpackage-automationjourneys.show
      with:
        publicationId: tools.publicationId
        automationId: tools.automationId
        automationJourneyId: tools.automationJourneyId
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.