Skip to main content

Event Types

This event is fired when a new user registers an account, either as a stand-alone signup or after placing an order.

Signature

constructor

method(ctx: RequestContext, user: User) => AccountRegistrationEvent

This event is fired when a users email address successfully gets verified after the verifyCustomerAccount mutation was executed.

Signature

constructor

method(ctx: RequestContext, customer: Customer) => AccountVerifiedEvent

This event is fired whenever a Administrator is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: Administrator, type: 'created' | 'updated' | 'deleted', input?: AdministratorInputTypes) => AdministratorEvent

This event is fired whenever an Asset is assigned or removed From a channel.

Signature

constructor

method(ctx: RequestContext, asset: Asset, channelId: ID, type: 'assigned' | 'removed') => AssetChannelEvent

This event is fired whenever a Asset is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: Asset, type: 'created' | 'updated' | 'deleted', input?: AssetInputTypes) => AssetEvent

asset

propertyAssetv1.4

This event is fired when an attempt is made to log in via the shop or admin API login mutation. The strategy represents the name of the AuthenticationStrategy used in the login attempt. If the "native" strategy is used, the additional identifier property will be available.

Signature

constructor

method(ctx: RequestContext, strategy: string, identifier?: string) => AttemptedLoginEvent

This event is fired whenever an ChannelAware entity is assigned or removed from a channel. The entity property contains the value before updating the channels.

Signature

constructor

method(ctx: RequestContext, entity: T, channelIds: ID[], type: 'assigned' | 'removed', entityType?: Type<T>) => ChangeChannelEvent

This event is fired whenever a Channel is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: Channel, type: 'created' | 'updated' | 'deleted', input?: ChannelInputTypes) => ChannelEvent

This event is fired whenever a Collection is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: Collection, type: 'created' | 'updated' | 'deleted', input?: CollectionInputTypes) => CollectionEvent

This event is fired whenever a Collection is modified in some way. The productVariantIds argument is an array of ids of all ProductVariants which:

  1. were part of this collection prior to modification and are no longer
  2. are now part of this collection after modification but were not before
Signature

constructor

method(ctx: RequestContext, collection: Collection, productVariantIds: ID[]) => CollectionModificationEvent

This event is fired whenever a Country is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: Country, type: 'created' | 'updated' | 'deleted', input?: CountryInputTypes) => CountryEvent

This event is fired whenever an coupon code of an active Promotion is assigned or removed to an Order.

Signature

constructor

method(ctx: RequestContext, couponCode: string, orderId: ID, type: 'assigned' | 'removed') => CouponCodeEvent

This event is fired whenever a Address is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: Address, type: 'created' | 'updated' | 'deleted', input?: CustomerAddressInputTypes) => CustomerAddressEvent

address

propertyAddress

This event is fired whenever a Customer is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: Customer, type: 'created' | 'updated' | 'deleted', input?: CustomerInputTypes) => CustomerEvent

customer

propertyCustomerv1.4

This event is fired whenever one or more Customer is assigned to or removed from a CustomerGroup.

Signature

constructor

method(ctx: RequestContext, customers: Customer[], customGroup: CustomerGroup, type: 'assigned' | 'removed') => CustomerGroupChangeEvent

This event is fired whenever a CustomerGroup is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: CustomerGroup, type: 'created' | 'updated' | 'deleted', input?: CustomerGroupInputTypes) => CustomerGroupEvent

This event is fired whenever a Facet is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: Facet, type: 'created' | 'updated' | 'deleted', input?: FacetInputTypes) => FacetEvent

This event is fired whenever a FacetValue is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: FacetValue, type: 'created' | 'updated' | 'deleted', input?: FacetValueInputTypes) => FacetValueEvent

This event is fired whenever a Fulfillment is added. The type is always created.

Signature

constructor

method(ctx: RequestContext, entity: Fulfillment, input?: CreateFulfillmentInput) => FulfillmentEvent

This event is fired whenever an Fulfillment transitions from one FulfillmentState to another.

Signature

constructor

method(fromState: FulfillmentState, toState: FulfillmentState, ctx: RequestContext, fulfillment: Fulfillment) => FulfillmentStateTransitionEvent

This event is fired whenever a GlobalSettings is added. The type is always updated, because it's only created once and never deleted.

Signature

constructor

method(ctx: RequestContext, entity: GlobalSettings, input?: UpdateGlobalSettingsInput) => GlobalSettingsEvent

This event is fired whenever one HistoryEntry is added, updated or deleted.

Signature

historyType

property'order' | 'customer' | string

constructor

method(ctx: RequestContext, entity: HistoryEntry, type: 'created' | 'updated' | 'deleted', historyType: 'order' | 'customer' | string, input?: HistoryInput) => HistoryEntryEvent

This event is fired when a registered user successfully changes the identifier (ie email address) associated with their account.

Signature

constructor

method(ctx: RequestContext, user: User, oldIdentifier: string) => IdentifierChangeEvent

This event is fired when a registered user requests to update the identifier (ie email address) associated with the account.

Signature

constructor

method(ctx: RequestContext, user: User) => IdentifierChangeRequestEvent

This event is fired when vendure finished initializing its services inside the InitializerService

Signature

constructor

method() => InitializerEvent

This event is fired when a user successfully logs in via the shop or admin API login mutation.

Signature

constructor

method(ctx: RequestContext, user: User) => LoginEvent

This event is fired when a user logs out via the shop or admin API logout mutation.

Signature

constructor

method(ctx: RequestContext) => LogoutEvent

This event is fired whenever an Order is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, order: Order, type: 'created' | 'updated' | 'deleted', input?: OrderInputTypes) => OrderEvent

order

propertyOrderv3.4.0

This event is fired whenever an OrderLine is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, order: Order, orderLine: OrderLine, type: 'created' | 'updated' | 'deleted' | 'cancelled') => OrderLineEvent

This event is fired whenever an Order is set as "placed", which by default is when it transitions from 'ArrangingPayment' to either 'PaymentAuthorized' or 'PaymentSettled'.

Note that the exact point that it is set as "placed" can be configured according to the OrderPlacedStrategy.

Signature

constructor

method(fromState: OrderState, toState: OrderState, ctx: RequestContext, order: Order) => OrderPlacedEvent

This event is fired whenever an Order transitions from one OrderState to another.

Signature

constructor

method(fromState: OrderState, toState: OrderState, ctx: RequestContext, order: Order) => OrderStateTransitionEvent

This event is fired when a Customer requests a password reset email.

Signature

constructor

method(ctx: RequestContext, user: User) => PasswordResetEvent

This event is fired when a password reset is executed with a verified token.

Signature

constructor

method(ctx: RequestContext, user: User) => PasswordResetVerifiedEvent

This event is fired whenever a PaymentMethod is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: PaymentMethod, type: 'created' | 'updated' | 'deleted', input?: PaymentMethodInputTypes) => PaymentMethodEvent

This event is fired whenever a Payment transitions from one PaymentState to another, e.g. a Payment is authorized by the payment provider.

Signature

constructor

method(fromState: PaymentState, toState: PaymentState, ctx: RequestContext, payment: Payment, order: Order) => PaymentStateTransitionEvent

This event is fired whenever a Product is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, product: Product, channelId: ID, type: 'assigned' | 'removed') => ProductChannelEvent

This event is fired whenever a Product is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: Product, type: 'created' | 'updated' | 'deleted', input?: ProductInputTypes) => ProductEvent

product

propertyProductv1.4

This event is fired whenever a ProductOption is added or updated.

Signature

constructor

method(ctx: RequestContext, entity: ProductOption, type: 'created' | 'updated' | 'deleted', input?: ProductOptionInputTypes) => ProductOptionEvent

This event is fired whenever a ProductOptionGroup is assigned or removed from a Product.

Signature

constructor

method(ctx: RequestContext, product: Product, optionGroupId: ID, type: 'assigned' | 'removed') => ProductOptionGroupChangeEvent

This event is fired whenever a ProductOptionGroup is added or updated.

Signature

constructor

method(ctx: RequestContext, entity: ProductOptionGroup, type: 'created' | 'updated' | 'deleted', input?: ProductOptionGroupInputTypes) => ProductOptionGroupEvent

This event is fired whenever a ProductVariant is assigned or removed from a Channel.

Signature

constructor

method(ctx: RequestContext, productVariant: ProductVariant, channelId: ID, type: 'assigned' | 'removed') => ProductVariantChannelEvent

This event is fired whenever a ProductVariant is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: ProductVariant[], type: 'created' | 'updated' | 'deleted', input?: ProductVariantInputTypes) => ProductVariantEvent

variants

propertyProductVariant[]v1.4

This event is fired whenever a ProductVariantPrice is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: ProductVariantPrice[], type: 'created' | 'updated' | 'deleted', input?: ProductVariantInputTypes) => ProductVariantPriceEvent

This event is fired whenever a Promotion is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: Promotion, type: 'created' | 'updated' | 'deleted', input?: PromotionInputTypes) => PromotionEvent

This event is fired whenever a Province is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: Province, type: 'created' | 'updated' | 'deleted', input?: ProvinceInputTypes) => ProvinceEvent

This event is fired whenever a Refund is created

Signature

constructor

method(ctx: RequestContext, order: Order, refund: Refund, type: 'created') => RefundEvent

This event is fired whenever a Refund transitions from one RefundState to another.

Signature

constructor

method(fromState: RefundState, toState: RefundState, ctx: RequestContext, refund: Refund, order: Order) => RefundStateTransitionEvent

This event is fired whenever one Role is assigned or removed from a user. The property roleIds only contains the removed or assigned role ids.

Signature

constructor

method(ctx: RequestContext, admin: Administrator, roleIds: ID[], type: 'assigned' | 'removed') => RoleChangeEvent

This event is fired whenever one Role is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: Role, type: 'created' | 'updated' | 'deleted', input?: RoleInputTypes) => RoleEvent

This event is fired whenever a search query is executed.

Signature

constructor

method(ctx: RequestContext, input: ExtendedSearchInput) => SearchEvent

This event is fired whenever one Seller is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: Seller, type: 'created' | 'updated' | 'deleted', input?: SellerInputTypes) => SellerEvent

This event is fired whenever a ShippingMethod is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: ShippingMethod, type: 'created' | 'updated' | 'deleted', input?: ShippingMethodInputTypes) => ShippingMethodEvent

This event is fired whenever a StockLocation is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: StockLocation, type: 'created' | 'updated' | 'deleted', input?: StockLocationInputTypes) => StockLocationEvent

This event is fired whenever a StockMovement entity is created, which occurs when the saleable stock level of a ProductVariant is altered due to things like sales, manual adjustments, and cancellations.

Signature

type

propertyStockMovementType

constructor

method(ctx: RequestContext, stockMovements: StockMovement[]) => StockMovementEvent

This event is fired whenever a TaxCategory is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: TaxCategory, type: 'created' | 'updated' | 'deleted', input?: TaxCategoryInputTypes) => TaxCategoryEvent

This event is fired whenever a TaxRate is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: TaxRate, type: 'created' | 'updated' | 'deleted', input?: TaxRateInputTypes) => TaxRateEvent

This event is fired whenever a TaxRate is changed

Signature

constructor

method(ctx: RequestContext, taxRate: TaxRate) => TaxRateModificationEvent

This event is fired whenever a Zone is added, updated or deleted.

Signature

constructor

method(ctx: RequestContext, entity: Zone, type: 'created' | 'updated' | 'deleted', input?: ZoneInputTypes) => ZoneEvent

This event is fired whenever a Zone gets Country members assigned or removed The entity property contains the zone with the already updated member field.

Signature

constructor

method(ctx: RequestContext, entity: Zone, type: 'assigned' | 'removed', memberIds: ID[]) => ZoneMembersEvent
Was this chapter helpful?
Report Issue
Edited Feb 10, 2026·Edit this page