Skip to main content

SupplyEventSubscription

Entity representing a subscription to supply events.

type SupplyEventSubscription {
createdAt: String!
endpoint: String!
eventSubscriptionId: ID!
itemType: String!
mutationType: SupplyEventMutationType!
protocol: SupplyEventProtocol!
subscriptionEntityId: ID!
subscriptionEntityType: SupplyEventSubscriptionEntityType!
subscriptionOwnerId: ID!
updatedAt: String!
updatedBy: ID!
}

Fields​

SupplyEventSubscription.createdAt ● String! non-null scalar​

SupplyEventSubscription.endpoint ● String! non-null scalar​

Changes based on protocol, but indicates the exact target.

SupplyEventSubscription.eventSubscriptionId ● ID! non-null scalar​

SupplyEventSubscription.itemType ● String! non-null scalar​

The SupplyEntity to subscribe to, all lowercase.

SupplyEventSubscription.mutationType ● SupplyEventMutationType! non-null enum​

What type of event to listen for.

SupplyEventSubscription.protocol ● SupplyEventProtocol! non-null enum​

The protocol to use to supply the event.

SupplyEventSubscription.subscriptionEntityId ● ID! non-null scalar​

This is the "main" entity that is being subscribed to. This can either be a ResonanceDomainEntityId (SupplierId, DemandHqId) to subscribe to an entity to which they have access. This is useful to monitor things like changes to Products and such. Or an Identity (AppClientId, UserName) to subscribe to THEMSELF. This is useful to monitor things like app installations, uninstallations, and such. subscriptionEntityType indicates what type of entity this is.

SupplyEventSubscription.subscriptionEntityType ● SupplyEventSubscriptionEntityType! non-null enum​

This distinguishes between the types of subscriptions.

SupplyEventSubscription.subscriptionOwnerId ● ID! non-null scalar​

The app (not appClient) or user that owns the subscription.

SupplyEventSubscription.updatedAt ● String! non-null scalar​

SupplyEventSubscription.updatedBy ● ID! non-null scalar​

Returned by​

createSupplyEventSubscription mutation ● supplyEventSubscription query

Member of​

SupplyEventSubscriptionConnection object ● SupplyEventSubscriptionEdge object