Ping Notifications

You can define Ping notifications for your product that Email Marketing automatically sends to a customer whenever a pre-defined event happens to their Premium subscription. You can check this guide for a complete list of supported parameters that Wix Premium forwards to Email Marketing and for which events (notification types) they're sent.

Follow this flow to set up your notification templates:

  1. Create a design sketch for each of the notificationTypes that you want to use. You don't have to use all types.
  2. Discuss all email designs with the Email Marketing team and get their approval.
  3. Add a new JSON file for your notification integration to GitHub. Follow this pattern for the name of your JSON file: premium-<YOUR_BUSINESS_PROPOSITION>-notifications.json. For example, premium-facebook-notifications.json.
    We recommend to:
    1. Copy an existing premium-<EXAMPLE>-notifications.json file from the repo and rename it following the above mentioned format.
    2. Adjust the array of main objects in your JSON file, so that you have one object per notification type that you want to use. You don't have to send notifications for every event, simply choose the ones that are relevant for your product. The object names must follow this format: premium.<YOUR_BUSINESS_PROPOSITION>.<notificationType>. For example, premium.facebook.initial_purchase.
    3. Adjust the values for each description and responsysTemplate. You need to ask the Email Marketing team for the correct value of each responsysTemplate.

You can read more about general restrictions in the Ping API.

Troubleshooting

In case no notifications are sent, follow these steps in order:

  1. Check the spelling of the main object names in your JSON file.
  2. Check the spelling of the responsysTemplate values.
  3. Contact the Premium team for more information.

Supported notification types and parameters

Whenever a pre-defined trigger event happens, Wix Premium forwards notification parameters to Email Marketing, which are then used to send a Ping notifications based on your templates to the relevant customer. Wix Premium sends each notification parameter in string format.

You don't have to send an email for every event type, and you also don't have to use all parameters in the relevant templates. But you must contact the Premium team if you want to send notifications for additional trigger events or if you want to use more parameters for an existing trigger event.

Notification Type
Trigger condition
Ping Parameters
CREATEDA customer has purchased a subscription for the product.BILLINGVENDOR, SBS_PRODUCT_ID, PRODUCT_TYPE_NAME, CYCLE_ID, PAYMENT_CYCLE, NEXT_RENEWAL_DATE, NEXT_RENEWAL_AMOUNT, NEXT_RENEWAL_CURRENCY, SITE_NAME, MSID, BY, INVOICE_NUM, DOMAIN_VOUCHER
AUTO_RENEW_TURNED_OFFA subscription's automatically recurring payment is disabled.PRODUCT_NAME, PRODUCT_TYPE_NAME, NEXT_BILLING_DATE, SITE_NAME, DOMAIN_NAME
ABOUT_TO_BE_RENEWEDA subscription is about to renew. Only available for subscriptions with recurring payments. You can set the number of days before the actual renewal in SBS.PACKAGE_ID, CURRENCY, CYCLE, MSID, PRODUCT_NAME, SITE_NAME, DOMAIN_NAME, PRICE, NEXT_RENEWAL_DATE, PRODUCT_TYPE_NAME
CHARGE_FAILUREA recurring charge for a subscription has failed. This doesn't mean that the subscription is canceled, since there are several payment attempts. Only available for subscriptions with recurring payments.PACKAGE_ID, PRODUCT_NAME, PRODUCT_TYPE_NAME, NEXT_BILLING_DATE, SITE_NAME, SUBSCRIPTION_TYPE, AMOUNT, CURRENCY_SYMBOL
NO_ACTIVE_BILLING_ACCOUNTBilling isn't set up properly for a subscription.PACKAGE_ID, PRODUCT_NAME, PRODUCT_TYPE_NAME, SITE_NAME, EMAIL, DOMAIN_NAME
CANCELLED_BY_USERThe customer cancels a subscription.PRODUCT_NAME, PRODUCT_TYPE_NAME, SITE_NAME, DOMAIN_NAME
ABOUT_TO_BE_RENEWED_UPGRADE_CYCLEA subscription is about to renew and there is an offer to upgrade the cycle. Only available for subscriptions with recurring payments. You can set the number of days before the actual renewal in SBS.BILLINGVENDOR, SBS_PRODUCT_ID, PRODUCT_TYPE_NAME, CYCLE_ID, PAYMENT_CYCLE, NEXT_RENEWAL_DATE, NEXT_RENEWAL_AMOUNT, NEXT_RENEWAL_CURRENCY, SITE_NAME, MSID, BY, INVOICE_NUM, DOMAIN_VOUCHER
ABOUT_TO_EXPIREA subscription is about to expire. Only available for subscriptions with recurring payments. You can set the number of days before the actual expiration in SBS.EXPIRATION_DATE
RECURRING_SUCCESSA recurring charge has succeeded and the subscription is extended for an additional cycle. Only available for subscriptions with recurring payments.-
CANCELLED_PAYMENT_PROBLEMSA subscription is canceled due to payment problems.PRODUCT_NAME, SITE_NAME, DOMAIN_NAME
NO_ACTIVE_BILLING_ACCOUNTA subscription doesn't have an active billing account.PRODUCT_NAME, PRODUCT_TYPE_NAME, SITE_NAME, DOMAIN_NAME, PACKAGE_ID, EMAIL
CHARGEBACKThere is a charge-back for a subscription.INVOICE_ID
MANUAL_RECURRING_REMINDERA reminder for a manual payment is sent. Only available for subscriptions with manual payments.PRODUCT_NAME, PRODUCT_TYPE_NAME, SITE_NAME, DOMAIN_NAME, PACKAGE_ID, EXPIRATION_DATE
OFFLINE_PAYMENTThe customer must pay offline. Only available for subscriptions with SEPA payments when the invoice status is PAYMENT_IN_PROGRESS.PRODUCT_NAME, VOUCHERS
Did this help?