Adobe Campaign Workflow API

openapi: 3.1.0
info:
  title: Adobe Campaign Classic Custom Resources Workflow API
  description: SOAP-based API for Adobe Campaign Classic v7 and v8, documented as HTTP POST operations. All operations target the single SOAP router endpoint at /nl/jsp/soaprouter.jsp and are differentiated by the SOAPAction header. Provides programmatic access to session management, data querying, record persistence, delivery management, workflow control, subscription management, and real-time transactional event ingestion.
  version: 8.0.0
  contact:
    name: Adobe Developer Support
    url: https://developer.adobe.com/
  license:
    name: Proprietary
    url: https://www.adobe.com/legal/terms.html
  x-logo:
    url: https://www.adobe.com/content/dam/cc/icons/adobe-campaign.svg
servers:
- url: https://{instance}.campaign.adobe.com
  description: Campaign Classic Instance
  variables:
    instance:
      description: Your Campaign Classic instance name
      default: YOUR_INSTANCE
tags:
- name: Workflow
  description: Start, stop, and signal workflows. PostEvent sends asynchronous signals to trigger workflow transitions.
paths:
  /nl/jsp/soaprouter.jsp/xtk-workflow/Start:
    post:
      operationId: workflowStart
      summary: Adobe Campaign Start a Workflow
      description: 'Starts a workflow by its internal ID. The workflow must be in a stopped state. SOAP Action: xtk:workflow#Start'
      tags:
      - Workflow
      parameters:
      - name: SOAPAction
        in: header
        required: true
        schema:
          type: string
          const: xtk:workflow#Start
        example: example_value
      security:
      - SessionToken: []
      requestBody:
        required: true
        content:
          text/xml:
            schema:
              $ref: '#/components/schemas/WorkflowRequest'
      responses:
        '200':
          description: Workflow started successfully.
        '500':
          $ref: '#/components/responses/SOAPFault'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /nl/jsp/soaprouter.jsp/xtk-workflow/Stop:
    post:
      operationId: workflowStop
      summary: Adobe Campaign Stop a Workflow
      description: 'Stops a running workflow by its internal ID. SOAP Action: xtk:workflow#Stop'
      tags:
      - Workflow
      parameters:
      - name: SOAPAction
        in: header
        required: true
        schema:
          type: string
          const: xtk:workflow#Stop
        example: example_value
      security:
      - SessionToken: []
      requestBody:
        required: true
        content:
          text/xml:
            schema:
              $ref: '#/components/schemas/WorkflowRequest'
      responses:
        '200':
          description: Workflow stopped successfully.
        '500':
          $ref: '#/components/responses/SOAPFault'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /nl/jsp/soaprouter.jsp/xtk-workflow/PostEvent:
    post:
      operationId: workflowPostEvent
      summary: Adobe Campaign Post an Event Signal to a Workflow
      description: 'Sends an asynchronous signal event to a workflow, triggering a transition from an external signal activity. Can include parameters passed as XML variables. SOAP Action: xtk:workflow#PostEvent'
      tags:
      - Workflow
      parameters:
      - name: SOAPAction
        in: header
        required: true
        schema:
          type: string
          const: xtk:workflow#PostEvent
        example: example_value
      security:
      - SessionToken: []
      requestBody:
        required: true
        content:
          text/xml:
            schema:
              $ref: '#/components/schemas/WorkflowPostEventRequest'
      responses:
        '200':
          description: Event signal posted to workflow.
        '500':
          $ref: '#/components/responses/SOAPFault'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    WorkflowRequest:
      type: object
      description: SOAP envelope containing the workflow internal ID for start/stop operations.
      properties:
        workflowId:
          type: integer
          description: Internal ID of the workflow.
          example: 42
    WorkflowPostEventRequest:
      type: object
      description: SOAP envelope containing a signal event to post to a workflow, including the workflow ID, signal activity name, and optional XML variables.
      properties:
        workflowId:
          type: integer
          description: Internal ID of the target workflow.
          example: 42
        activity:
          type: string
          description: Name of the external signal activity in the workflow.
          example: example_value
        variables:
          type: object
          description: XML element containing variable parameters to pass to the workflow transition.
          additionalProperties: true
    SOAPFault:
      type: object
      description: SOAP fault response indicating an error during operation processing.
      properties:
        faultcode:
          type: string
          description: Fault code identifying the error category.
          example: example_value
        faultstring:
          type: string
          description: Human-readable description of the error.
          example: example_value
        detail:
          type: string
          description: Additional error details.
          example: example_value
  responses:
    SOAPFault:
      description: SOAP fault indicating an error during operation processing.
      content:
        text/xml:
          schema:
            $ref: '#/components/schemas/SOAPFault'
  securitySchemes:
    SessionToken:
      type: apiKey
      in: header
      name: X-Security-Token
      description: Security token obtained from xtk:session#Logon. Must be passed alongside the session token cookie (__sessiontoken) on all authenticated requests. Tokens have a 24-hour lifecycle.
externalDocs:
  description: Campaign Classic SOAP Web Services Documentation
  url: https://experienceleague.adobe.com/docs/campaign-classic/using/configuring-campaign-classic/api/web-service-calls.html