---
title: "Subscriber"
url: "https://developers.zinnia.com/apis/market-connect-order-entry/versions/50f981c3-db50-4358-884f-31eb427255ec/schemas/Subscriber"
---

> Full API specification: https://developers.zinnia.com/apis/market-connect-order-entry/versions/50f981c3-db50-4358-884f-31eb427255ec.md

# Subscriber

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Market Connect Order Entry API
  version: 1.0.3
servers:
  - url: https://dev.api.zinnia.io
  - url: https://qa.api.zinnia.io
  - url: https://uat.api.zinnia.io
components:
  schemas:
    SubscriberAction:
      type: object
      properties:
        type:
          type: string
          description: The action transport. Currently always "http".
          nullable: true
        verb:
          type: string
          description: HTTP verb to use (e.g., "get", "post").
          nullable: true
        url:
          type: string
          description: "Relative URL of the OE endpoint to call when the trigger fires.
            Three shapes are emitted: '/market-connect/order-entry/v1/dataset'
            (dataset refresh);
            '/market-connect/order-entry/v1/transaction/{transactionId}/{stepNa\
            me}' (multi-step blueprint refresh);
            '/market-connect/order-entry/v1/transaction/{transactionId}'
            (single/enhanced blueprint refresh)."
          nullable: true
        token:
          type: string
          description: Bearer-token alias forwarded by the UI on the call. Always
            "OEToken" today.
          nullable: true
        payload:
          allOf:
            - $ref: "#/components/schemas/SubscriberActionPayload"
          description: Request payload envelope. Use type "none" when no body is required.
          example:
            type: basic
            payload:
              transactionId: "1125715"
              stepName: MCDPS
              fieldId: "531783"
        responseHandlers:
          type: array
          items:
            $ref: "#/components/schemas/SubscriberResponseHandler"
          description: One or more handlers that apply the upstream response back to the
            form.
          nullable: true
      additionalProperties: false
      example:
        type: http
        verb: get
        url: /market-connect/order-entry/v1/transaction/1064727
        token: OEToken
        payload:
          type: none
        responseHandlers:
          - type: blueprint-modification
            action: replace-whole
            value:
              type: response-query
              kind: json-path
              value: $.data
    SubscriberActionPayload:
      type: object
      properties:
        type:
          type: string
          description: Payload kind. "basic" includes a key/value map in the "payload"
            field; "none" omits the body.
          nullable: true
        payload:
          type: object
          additionalProperties:
            type: string
          description: Inner payload key/value map. Omitted from the JSON envelope when
            type is "none".
          nullable: true
      additionalProperties: false
      example:
        type: basic
        payload:
          transactionId: "1125715"
          stepName: MCDPS
          fieldId: "531783"
    SubscriberResponseHandler:
      type: object
      properties:
        type:
          type: string
          description: Handler kind. "context-modification" updates a context namespace;
            "blueprint-modification" applies the response to the rendered
            blueprint.
          nullable: true
        action:
          type: string
          description: 'Action to perform within the chosen handler kind. Examples:
            "update-namespace", "replace-whole".'
          nullable: true
        namespace:
          type: string
          description: Namespace to update for context-modification handlers. Omitted for
            handler types that do not use a namespace.
          nullable: true
        value:
          allOf:
            - $ref: "#/components/schemas/SubscriberResponseValue"
          description: How to extract the value to apply from the upstream response.
          example:
            type: response-query
            kind: json-path
            value: $.data
      additionalProperties: false
      example:
        type: blueprint-modification
        action: replace-whole
        value:
          type: response-query
          kind: json-path
          value: $.data
    SubscriberResponseValue:
      type: object
      properties:
        type:
          type: string
          description: Value source kind. "response-query" extracts via a query expression
            on the response body.
          nullable: true
        kind:
          type: string
          description: Query language used to evaluate the value expression. Currently
            always "json-path".
          nullable: true
        value:
          type: string
          description: The query expression itself (e.g., "$.data" to grab the response's
            data branch).
          nullable: true
      additionalProperties: false
      example:
        type: response-query
        kind: json-path
        value: $.data
    Subscriber:
      type: object
      properties:
        triggers:
          type: array
          items:
            type: string
          description: NamedItem identifiers of the form fields whose value change fires
            this subscriber.
          nullable: true
        conditions:
          type: array
          items: {}
          description: Optional conditions that must hold for the subscriber to execute.
            Omitted when not used.
          nullable: true
        actions:
          type: array
          items:
            $ref: "#/components/schemas/SubscriberAction"
          description: Actions executed when any of the triggers fire. Each action
            declares an HTTP call plus one or more response handlers.
          nullable: true
      additionalProperties: false
      example:
        triggers:
          - FirstName
        actions:
          - type: http
            verb: get
            url: /market-connect/order-entry/v1/transaction/1125715/MCDPS
            token: OEToken
            payload:
              type: none
            responseHandlers:
              - type: blueprint-modification
                action: replace-whole
                value:
                  type: response-query
                  kind: json-path
                  value: $.data
```