Request

Response

    Domain Events

    The Manufacturing Data Model API generates domain events when data changes occur within a hub. Events are delivered in real time over PubNub and can be used to build integrations that react to changes such as new versions being created, component properties being updated, or lifecycle state transitions.

    Events are scoped to a target entity. When an event fires on a child entity, it bubbles up to its parent scope so that subscribers listening at a broader level also receive the notification.

    Subscribing to Events

    Use the addEventListener mutation to register a listener on a target entity. The listener is associated with a PubNub channel on which event payloads are delivered.

    mutation AddEventListener($input: AddEventListenerInput!) {
      addEventListener(input: $input) {
        credentials {
          cipherKey
          subscriptionKey
        }
        eventListener {
          id
          targetId
          channelId
          eventType
          expiration
        }
      }
    }
    
    Show More

    Variables:

    {
      "input": {
        "targetId": "<component-or-asset-id>",
        "eventType": "autodesk.data.mfgdm:version.created-1.0.0",
        "expiration": "2026-12-31T23:59:59.000Z",
        "channelId": "<your-pubnub-channel-id>"
      }
    }
    
    Show More

    The credentials object returned contains the PubNub subscriptionKey and cipherKey needed to connect to the channel and decrypt incoming messages. The listener stops delivering events after the expiration timestamp; use the updateEventListenerExpiration mutation to extend it.

    Note: Wildcard notation is supported in the eventType field. For example, autodesk.data.mfgdm:bomrelation.*-1.0.0 subscribes to all BOM relation event types at once.

    See the addEventListener and addEventListenerInput reference pages for full argument details.

    Event Type String Format

    Every event is identified by a type string with the following structure:

    {edoSystemId}:{entityType}.{eventId}-{version}
    
    • edoSystemId — the event domain object (EDO) namespace. Manufacturing data events use the autodesk.data.mfgdm namespace.
    • entityType — the type of entity the event relates to (for example, component, version, model).
    • eventId — identifies the specific action (for example, created, updated, deleted).
    • version — schema version of the event payload (for example, 1.0.0).

    Example: autodesk.data.mfgdm:version.created-1.0.0

    Scope Types

    Each event has one or more scope types that determine which entity IDs can be used as the targetId when registering a listener. For example, a version event with scope type asset can be subscribed to at the asset level, and all version events within that asset are delivered to the listener.

    When an event fires, the scopes field in the delivered payload lists all the ancestor scope IDs to which the event has bubbled.

    Base Event Payload

    All event payloads include the following base fields in addition to the event-specific fields described below:

    • targetId (String, required) — the ID of the GraphQL entity targeted by the event. targetId can be either a specific object (such as a Component or Version) or the Hub ID. When the hub ID is used, the subscriber receives all events emitted within that hub.
    • scopes (String[], optional) — list of scope IDs the event has bubbled to.

    Events

    version

    Scope types: asset, collection

    Event Type StringDescription
    autodesk.data.mfgdm:version.created-1.0.0 Sent when a new Version is created via the createVersion mutation.
    autodesk.data.mfgdm:version.started-1.0.0 Sent when the process of creating a new Version has started.
    autodesk.data.mfgdm:version.failed-1.0.0 Sent when the creation of a new Version failed.

    Payload: version.created

    • targetId String
    • versionId String — ID of the new Version.
    • description String — description of the version.
    • author String — User ID of the creator.
    • historyChangeId String (optional) — ID of the VersionCreatedHistoryChange.

    Payload: version.started

    • targetId String
    • versionId String — ID of the Version.
    • description String
    • author String — User ID of the user.

    Payload: version.failed

    • targetId String
    • versionId String — ID of the Version.
    • description String
    • author String — User ID of the user.
    • code String — error code.
    • message String — error message.

    component

    Scope types: asset, collection

    Event Type StringDescription
    autodesk.data.mfgdm:component.property.updated-1.0.0 Sent when a property value is updated on a component.
    autodesk.data.mfgdm:component.partnumber.updated-1.0.0 Sent when the part number value is updated on a component.
    autodesk.data.mfgdm:component.primary.updated-1.0.0 Sent when the primary model flag is updated on a component.
    autodesk.data.mfgdm:component.bom.updated-1.0.0 Sent when the BOM is updated on a component.
    autodesk.data.mfgdm:component.lifecycle.updated-1.0.0 Sent when a component lifecycle state changes (release, lock, unlock, pending change, or cancel pending change).
    autodesk.data.mfgdm:component.bomrelations.reorderlist-1.0.0 Sent when BOM relations are reordered under a Component.

    Payload: component.property.updated

    • targetId String
    • author String — User ID of the user who made the update.
    • props Array — list of updated properties. Each entry contains:

      • id String — property definition ID.
      • value String — stringified raw new value.
      • name String (optional) — named GraphQL path, for example physicalProperties.area or description.
      • valueInfo String[] (optional) — contains USER_DRIVEN entries; omitted if the update was system-driven.
      • source Object[] (optional) — source values when not system-driven, each containing { value: string }.
    • historyChangeId String (optional) — ID of the PropertiesUpdatedHistoryChange.

    Payload: component.partnumber.updated

    • targetId String
    • partNumber String — new part number. Can be an empty string for delete operations.
    • componentId String (optional) — ID of the Component.
    • previousComponentId String (optional) — ID of the previous Component.
    • previousPartNumber String (optional)
    • time String (optional) — transaction or custom commit timestamp.
    • triggerSource String (optional) — operation that triggered the event, for example Delete DM operation.
    • historyChangeId String (optional) — ID of the ComponentPartNumberHistoryChange.

    Payload: component.primary.updated

    • targetId String
    • preivousPrimaryModelId String (optional) — ID of the previous primary Model.
    • newPrimaryModelId String (optional) — ID of the new primary Model.
    • time String
    • historyChangeId String (optional) — ID of the ComponentPrimaryHistoryChange.

    Note: The field preivousPrimaryModelId is misspelled in the current implementation. See Known Issues for details and workaround guidance.

    Payload: component.lifecycle.updated

    • targetId String
    • author String (optional) — User ID of the user.
    • revisionId String — ID of the Revision.
    • changeType Enum — RELEASED | LOCKED | UNLOCKED | PENDING_CHANGE | CANCEL_PENDING_CHANGE.
    • effectiveOn String (optional) — ISO 8601 date; present only for RELEASED.
    • revision String (optional) — revision number; present only for RELEASED.
    • changeOrder String (optional) — change order URN; present for all change types except a quick-release RELEASED.

    model

    Scope types: asset, collection

    Event Type StringDescription
    autodesk.data.mfgdm:model.saved-1.0.0 Sent when a model is saved.
    autodesk.data.mfgdm:model.partnumber.updated-1.0.0 Sent when a model part number is updated via assignModelPartNumber.
    autodesk.data.mfgdm:model.primary.updated-1.0.0 Sent when a model’s primary flag is updated.

    Payload: model.saved

    • targetId String
    • historyChangeId String — ID of the ModelWrittenHistoryChange.
    • assemblyChange Boolean — whether there was a change to the assembly structure.
    • author String — User ID of the user.
    • sourceCopyMetadata Object (optional):

      • sourceModelId String — ID of the source Model copied from.
      • time String — timestamp of the source model.
      • primaryAtSource Boolean
      • primaryAtTarget Boolean

    Payload: model.partnumber.updated / model.primary.updated

    • targetId String
    • componentId String — ID of the Component.
    • isPrimary Boolean
    • time String

    bomrelation

    Scope types: asset, collection

    Event Type StringDescription
    autodesk.data.mfgdm:bomrelation.created-1.0.0 Sent when a new BOM relation is created.
    autodesk.data.mfgdm:bomrelation.updated-1.0.0 Sent when a BOM relation is updated.
    autodesk.data.mfgdm:bomrelation.deleted-1.0.0 Sent when a BOM relation is deleted.
    autodesk.data.mfgdm:bomrelation.property.updated-1.0.0 Sent when a property value is updated on a BOM relation.

    Payload: bomrelation.created / bomrelation.updated

    • targetId String
    • author String — User ID of the user.
    • fromComponent String — parent Component ID.
    • toComponent String — child Component ID.
    • fromTime String — ISO 8601; when the parent started consuming the child (immutable).
    • toTime String — ISO 8601; oldest version of the child consumable by the parent.

    Payload: bomrelation.deleted

    Same fields as bomrelation.created, without fromTime and toTime.

    Payload: bomrelation.property.updated

    Same structure as the component.property.updated payload.

    drawing

    Scope types: asset, collection

    Event Type StringDescription
    autodesk.data.mfgdm:drawing.property.updated-1.0.0 Sent when a Drawing property value is updated.
    autodesk.data.mfgdm:drawing.lifecycle.updated-1.0.0 Sent when a Drawing lifecycle state changes (release, lock, unlock, pending change, or cancel pending change).

    The drawing.property.updated payload follows the same structure as the component.property.updated payload. The drawing.lifecycle.updated payload follows the same structure as the component.lifecycle.updated payload.

    configuration

    Scope types: asset, collection

    Event Type StringDescription
    autodesk.data.mfgdm:configuration.table.updated-1.0.0 Sent when the configuration table is updated.

    Payload: configuration.table.updated

    • targetId String
    • itemId String (optional) — ID of the configured item (for example, a ConfiguredDesignItem).
    • aspects Array (optional) — list of updated aspects. Each entry contains:

      • objectType String — object type ID.
      • aspectType String — aspect type ID.
      • isConfigure Boolean — true for configure, false for de-configure.
      • objectIds String[] — IDs of the updated objects.
    • rows Array (optional) — list of updated rows. Each entry contains:

      • rowId String — ID of the ConfigurationRow.
      • rowName String
      • changeType Enum — CREATED | UPDATED | DELETED.