Notification Reference
Base Notification Content
These fields are present in all notification payloads, regardless of type.
| Name | Description | R / O |
|---|---|---|
| subject | Event entity type (order, subscription, endUser, etc.) | R |
| type | Notification event type (e.g. completed, deleted) | R |
| objectId | Entity identifier (orderId, subscriptionId, endUserId, etc.) | R |
| eventDate | ISO 8601 date of the event | R |
Notifications list
| Name | Payload | Subject | Type |
|---|---|---|---|
| Abandoned Cart Notification | ABANDONED_CART | Cart | campaign-configuration |
| Cart Abandoned | ABANDONED_CART | cart | abandoned |
| Cart created | CART | cart | created |
| Consent Created | CONSENT_CREATED | consent | created |
| Consent Updated | CONSENT_UPDATED | consent | updated |
| End User Created | END_USER_CREATED | endUser | created |
| EndUser Deleted | END_USER_DELETED | endUser | deleted |
| End User Updated | END_USER_UPDATED | endUser | updated |
| Credit Card Added | PAYMENT_METHOD_ADDED | endUser | paymentMethodAddedToWallet |
| Recurring Payment Method Added | PAYMENT_METHOD_ADDED | endUser | paymentMethodAddedToWallet |
| SEPA Payment Method Added | PAYMENT_METHOD_ADDED | endUser | paymentMethodAddedToWallet |
| Payment Method Deleted | PAYMENT_METHOD_DELETED | endUser | paymentMethodDeletedFromWallet |
| Subscription Payment Method Updated | PAYMENT_METHOD_UPDATED | endUser | subscriptionPaymentMethodUpdated |
| Reseller Request Approved | RESELLER | endUser | completed |
| Reseller Request Declined | RESELLER | endUser | declined |
| Reseller Request OnBoarding | RESELLER | endUser | onBoardingRequest |
| Identity created | IDENTITY | identity | created |
| Identity deleted | IDENTITY | identity | deleted |
| Identity updated | IDENTITY | identity | updated |
| Package Threshold Reached | LICENSE_KEY_PACKAGE | licenseKeyPackage | thresholdReached |
| SUBSCRIPTION-suspended-1046862457 | SUBSCRIPTION | notif-SUBSCRIPTION1046862457 | type-SUBSCRIPTION1046862457 |
| SUBSCRIPTION-suspended-1290070773 | SUBSCRIPTION | notif-SUBSCRIPTION1290070773 | type-SUBSCRIPTION1290070773 |
| SUBSCRIPTION-reactivated-1451092306 | SUBSCRIPTION | notif-SUBSCRIPTION1451092306 | type-SUBSCRIPTION1451092306 |
| SUBSCRIPTION-reactivated-1990355311 | SUBSCRIPTION | notif-SUBSCRIPTION1990355311 | type-SUBSCRIPTION1990355311 |
| OFFER ABORTED | ORDER | offer | aborted |
| Enter prebilling (test) | ORDER_AND_SUBSCRIPTION | order | updated |
| Offer Prebilling Started | ORDER_AND_SUBSCRIPTION | order | prebillingStarted |
| Order Canceled With Content Including Subscription Data | ORDER_AND_SUBSCRIPTION | order | canceled |
| Order Completed With Content Including Subscription Data | ORDER_AND_SUBSCRIPTION | order | completed |
| Prebilling Order Created | ORDER_AND_SUBSCRIPTION | order | prebillingStarted |
| Subscription Entered Prebilling | ORDER_AND_SUBSCRIPTION | order | PrebilingOrderCreated |
| Subscription Order Renew Completed | ORDER_AND_SUBSCRIPTION | order | renewCompleted |
| Subscription Order Renew Completed (offer) | ORDER_AND_SUBSCRIPTION | order | renewCompleted |
| Offer Order Aborted | ORDER | order | aborted |
| Offer Order Created | ORDER | order | created |
| Order Aborted | ORDER | order | aborted |
| Order Canceled | ORDER | order | canceled |
| Order Completed | ORDER | order | completed |
| Order Completed With Error | ORDER | order | partiallyCompleted |
| Order Created | ORDER | order | created |
| Order Fulfillment Failed | ORDER | order | fulfillmentFailed |
| Order Partial Completed | ORDER | order | partialCompleted |
| Order Payment Failed | ORDER | order | paymentFailed |
| Order Payment Refused | ORDER | order | paymentRefused |
| Order payment refused with last error code | ORDER | order | paymentRefusedWithLastErrorCode |
| Order Pending with Error | ORDER | order | updated |
| Partial refund completed successfully | ORDER | order | partialRefundCompleted |
| Partial refund completed with errors | ORDER | order | partialRefundFailed |
| Subscription Discount Plan Updated | DISCOUNT_PLAN_UPDATED | subscription | discountPlanUpdated |
| Check payment method replayability on updated subscription | SUBSCRIPTION_PAYMENT_METHOD_REPLAYABILITY_CHANGED | subscription | subscriptionPaymentMethodReplayabilityChanged |
| Benj Notfi Definition Test | SUBSCRIPTION | subscription | unpaidsubscription |
| Notification sub renew | SUBSCRIPTION | subscription | suspended |
| Subscription Canceled | SUBSCRIPTION | subscription | canceled |
| Subscription Created | SUBSCRIPTION | subscription | created |
| Subscription created | SUBSCRIPTION | subscription | created |
| Subscription Expiration Date Updated | SUBSCRIPTION | subscription | expirationDateUpdated |
| Subscription Expired | SUBSCRIPTION | subscription | expired |
| Subscription Reactivated | SUBSCRIPTION | subscription | reactivated |
| Subscription Suspended | SUBSCRIPTION | subscription | suspended |
| Subscription Unpaid | SUBSCRIPTION | subscription | unpaid |
| Tax Rate Created | TAX_RATE | taxRate | created |
| Tax Rate Deleted | TAX_RATE | taxRate | deleted |
| Tax Rate Updated | TAX_RATE | taxRate | updated |
Payload schemas
AbandonedCartNotification
| Field | Type | Description | R/O |
|---|---|---|---|
| subject | string | Notification subject, e.g. order, subscription, endUser | R |
| type | string | Event type, e.g. created, completed, paymentFailed | R |
| objectId | string | Unique identifier of the object that triggered the event | R |
| eventDate | string (date-time) | Timestamp of the event in ISO 8601 format | R |
| checkoutUrl | string | O | |
| companyName | string | O | |
| customerId | string | O | |
| firstName | string | O | |
| lastName | string | O | |
| locale | string | O | |
| newsletterOptin | boolean | O | |
| storeHostname | string | O | |
| userEmailAddress | string | O |
BaseNotificationContent
| Field | Type | Description | R/O |
|---|---|---|---|
| subject | string | Notification subject, e.g. order, subscription, endUser | R |
| type | string | Event type, e.g. created, completed, paymentFailed | R |
| objectId | string | Unique identifier of the object that triggered the event | R |
| eventDate | string (date-time) | Timestamp of the event in ISO 8601 format | R |
ConsentNotification
| Field | Type | Description | R/O |
|---|---|---|---|
| subject | string | Notification subject, e.g. order, subscription, endUser | R |
| type | string | Event type, e.g. created, completed, paymentFailed | R |
| objectId | string | Unique identifier of the object that triggered the event | R |
| eventDate | string (date-time) | Timestamp of the event in ISO 8601 format | R |
| consent | consent.Consent | O | |
| → consents | consent.ConsentItem[] | O | |
| — → type | string | O | |
| — → lastLegalActionTimestamp | integer (int64) | O | |
| — → lastUpdateReason | string | O | |
| — → status | boolean | O | |
| → source | string | O | |
| → updateDate | string (date-time) | O | |
| → userEmail | string | O |
EndUserNotification
| Field | Type | Description | R/O |
|---|---|---|---|
| subject | string | Notification subject, e.g. order, subscription, endUser | R |
| type | string | Event type, e.g. created, completed, paymentFailed | R |
| objectId | string | Unique identifier of the object that triggered the event | R |
| eventDate | string (date-time) | Timestamp of the event in ISO 8601 format | R |
| endUser | enduser.EndUserDetails | O | |
| → city | string | City | O |
| → country | string | Alpha-2 country code | R |
| → customerId | string | Customer identifier the end user belongs to | R |
| string | End user email address | R | |
| → firstName | string | First name | O |
| → id | string | End user identifier | R |
| → lastName | string | Last name | O |
| → locale | string | Locale used by the end user, e.g. fr-FR | R |
| → region | string | Region code, e.g. FR-MQ | O |
| → storeId | string | Store identifier the end user belongs to | R |
OrderNotification
| Field | Type | Description | R/O |
|---|---|---|---|
| subject | string | Notification subject, e.g. order, subscription, endUser | R |
| type | string | Event type, e.g. created, completed, paymentFailed | R |
| objectId | string | Unique identifier of the object that triggered the event | R |
| eventDate | string (date-time) | Timestamp of the event in ISO 8601 format | R |
| order | order.Order | R | |
| → cancellationDate | string (date-time) | Cancellation timestamp in ISO 8601 format | O |
| → cancellationReason | string | Reason for order cancellation | O |
| → cartId | string | Associated cart identifier | O |
| → consentFlags | order.ConsentFlags | R | |
| — → newsletterOptin | boolean | Marketing newsletter consent indicator | R |
| → creationDate | string (date-time) | Order creation date in ISO 8601 format | R |
| → currency | string | Currency code, e.g. EUR, USD | R |
| → customer | order.Customer | R | |
| — → customerAccount | string | Realm/account name | R |
| — → id | string | Customer identifier | R |
| — → name | string | O | |
| — → serveur | string | O | |
| → decodedExternalContext | object | Decoded cart parameters | O |
| → externalContext | string | Base64 encoded string of cart parameters | O |
| → id | string | Order identifier | R |
| → items | order.LineItem[] | Order line items | R |
| — → activationCode | string | Product activation code | O |
| — → discountPlan | order.DiscountPlan | O | |
| — — → discountStep | integer (int32) | Step in the discount plan | R |
| — — → ignorePurchaseDiscount | boolean | Whether to ignore discount on the initial purchase | O |
| — — → tag | string | Plan designation tag | R |
| — → discountRate | number (double) | Discount rate applied | O |
| — → expirationDate | string (date-time) | Product expiration timestamp in ISO 8601 format | O |
| — → externalContext | string | External context data | R |
| — → extraTerm | order.ExtraTermBonusDetails | O | |
| — — → extraTermBonusTag | string | Extra term bonus tag | R |
| — — → unit | string | Extra term bonus unit | R |
| — — → value | integer (int32) | Extra term bonus value | R |
| — → fulfillmentId | string | Fulfillment process identifier | O |
| — → id | string | Unique line item identifier | R |
| — → isUpsell | boolean | Upsell status marker | O |
| — → lineItemDataId | string | Line item data identifier | R |
| — → lineItemId | string | Line item identifier. For compatibility purposes. | O |
| — → pricing | order.Pricing | R | |
| — — → allDiscountsApplied | com.nx.notification.externalapi.DiscountApplied[] | All discounts applied to this item | O |
| — — — → discountAmount | number (double) | Discount value | R |
| — — — → discountCode | string | Customer-facing discount code | O |
| — — — → discountId | string | Monetize discount identifier | R |
| — — — → discountRate | number (double) | Discount percentage, e.g. 0.2 for 20% | O |
| — — → cumulatedDiscountRate | number (double) | Total cumulated discount percentage | O |
| — — → unitPriceExclVAT | number (double) | Pre-tax unit cost | R |
| — — → unitPriceIncVAT | number (double) | Post-tax unit cost | R |
| — — → vatAmount | number (double) | Tax amount | O |
| — — → VATRate | number (double) | Tax rate percentage | R |
| — → priority | integer (int32) | Line item priority | O |
| — → product | order.Product | R | |
| — — → name | string | Product name | R |
| — — → publisherReference | string | Publisher's internal product identifier | O |
| — — → uniqueReference | string | Unique product identifier on the Nexway Monetize platform | R |
| — → publisherFulfillmentId | string | Publisher fulfillment identifier | O |
| — → quantity | integer (int32) | Product quantity | R |
| — → subItems | order.SubItem[] | Nested line items | O |
| — — → activationCode | string | O | |
| — — → externalContext | string | O | |
| — — → fulfillmentId | string | O | |
| — — → id | string | O | |
| — — → product | order.Product | O | |
| — — — → name | string | Product name | R |
| — — — → publisherReference | string | Publisher's internal product identifier | O |
| — — — → uniqueReference | string | Unique product identifier on the Nexway Monetize platform | R |
| — — → publisherFulfillmentId | string | O | |
| — → subscription | subscription.Subscription | O | |
| — — → createDate | string (date-time) | Creation date in ISO 8601 format | R |
| — — → discountPlan | subscription.DiscountPlan | O | |
| — — — → nextDiscountStep | integer (int32) | Calculated next discount step value | R |
| — — — → startingStep | integer (int32) | Starting step | O |
| — — — → tag | string | Plan identifier | R |
| — — → enduserId | string | End-user UUID | R |
| — — → id | string | Subscription UUID | R |
| — — → lifecycle | subscription.LifeCycle | R | |
| — — — → anniversaryDate | string (date-time) | Renewal/expiration date in ISO 8601 format | R |
| — — — → generation | integer (int32) | Renewal generation (term number) | R |
| — — — → id | string | Back-office subscription identifier (deprecated) | O |
| — — — → status | string | Status: Active, Suspended, Dunning, Canceled, Expired | R |
| — — → modelId | string | Model identifier, e.g. NEXWAY_1Y | R |
| — — → name | string | Product name | O |
| — — → paymentMethodIsNoLongerReplayable | boolean | Whether the payment method is no longer replayable | O |
| — — → paymentMethodIsNoLongerReplayableReason | string | Reason why the payment method is no longer replayable | O |
| — — → products | subscription.Product[] | Associated products | R |
| — — — → id | string | Product UUID | R |
| — — — → licenseId | string | License identifier | O |
| — — — → lineItemId | string | Order line item UUID | R |