Skip to main content
Push Notifications are web callbacks —also referred to as callbacks, webhooks or event-driven messaging. These allow you to proactively receive near real-time notifications of events as they occur, without polling for them through the API. Vindicia Subscribe Push notifications are actionable on their own, and will not typically require a subsequent API call. A push message includes the related API object or objects in JSON format. You set up a listener to Subscribe Events and then subscribe to any number of Event Classes or individual Events. When these events occur, you receive Push Notifications as HTTPS POST requests with a JSON formatted message. Vindicia MarketOne Subscribe provides push notification event classes for:
  • Accounts: Account Push Notifications proactively inform you about key Account change events such as account created, or account data change. The Account object is sent showing the account attributes. Receiving near real time account information from Subscribe is useful for different uses such as to notify your customer relations management (CRM) software, to prompt customer-facing applications to action, or to update high-touch customer records.
  • Subscriptions: Subscriptions Push Notifications proactively inform you about key subscription events such as a subscription started, a subscription stopped, a subscription was paused, or changes to the subscription (modified). The Subscription object is sent showing the subscription attributes.
  • Payment Methods: Payment Methods Push Notifications proactively inform you about key payment method change events such as Account Updater (AU) response for a credit card, payment method is activated on an account, or a billing address is changed. The payment method object is sent showing the payment method attributes. Receipt of near real time changes to on-file payment methods can assist you to update key customer records in your CRM software, or to prompt for action, when desired.
  • Entitlements: Entitlement Push Notifications proactively notify you when an entitlement starts and stops. The entitlement object is sent showing the entitlement attributes. Receipt of near real time changes of entitlement from Subscribe is useful for notifying a client provisioning system that automatically starts and stops customer subscriptions.
  • Transactions: Transactions Push Notifications proactively inform you about key transaction processing events such as Transaction succeeded (was captured), transaction failed, or Renewal transaction succeeded. The transaction object is sent showing the transaction attributes and status. Receipt of near real time transaction results from Subscribe can assist,to notify your customer-facing applications to prompt for action, when desired, or to extend your retention/dunning communication activity.
  • Invoices: Invoices Push Notifications inform you when key events occur for an Invoice, such as when a payment is recorded, or an invoice is created. The invoice object is sent showing the invoice attributes including opening balance,submitted payments, and current charges for a given billing cycle. The Invoice Push Notifications can be sent regardless of the payment method used.
  • Adjustments: Adjustments Push Notifications proactively inform you about financial adjustments to payments—specifically about refunds and chargebacks such as when a refund is issued for a transaction. In that case the Refund object is sent showing the refund attributes.
Parent topic:Vindicia Subscribe Platform Interfaces