Event Notifications

Event Notifications is an automated service that notify you about critical events that occur in your site and triggers automated action(s) by using SMS/messages, emails and webhooks. It is a no-code solution that is very simple to configure and requires no overhead on your side.

To add event notifications to your SubsBase site, go to your Admin Portal > Settings > Event Notifications > click the Add button at the top right of the page, then you will see a form with the following fields: event form

Event Name

(Required)
This is just an internal name that is only shown to the admin portal users, which will not be shown to your customers/subscribers. However, we recommend setting up a naming convention within your company to help differentiate between your event notifications.

Trigger when

(Required)
  • This is the list of events you choose from to trigger automated action(s).
  • Configuring event notifications automates the triggering of action(s) sent to a destination whenever those events happen.
  • So, if you configure trigger when subscription is renewed, the triggered action will be taken whenever customers renew their subscriptions.
    When this event happens, then trigger this action to be taken.
  • For example: When Subscription is renewed, send email to the customer.
  • In this example, "Send Email" is the triggered automated action that will be taken when the event "Subscription is renewed" happens. Email will be sent to the {{Customer.EmailAddress}} selected from the list of available placeholders.

Delay

(Optional)
delay
  • When the delay toggle is turned on, you can delay the event notifications to be sent to your customers/subscribers when needed.
  • This delay toggle is disabled by default.
  • You have three options to choose from when the delay toggle is enabled:
    • After: select the number of day(s), week(s), month(s), or year(s) to specify the duration after which the notification will be sent.
      • Specific Date: select the calendar day of the month, to specify the notification date.
      • Day of week: select from Sunday to Saturday to specify the notification day.

Conditions

(Optional)
  • This is an additional option that you can use for filtering, where you can configure complex event notifications that only match events under very specific conditions.
  • Event Notifications whose attributes match a condition will trigger action(s). Notifications whose attributes do not match a condition will not.

Action(s) taken

(Required)
  • An action happens as a result of a trigger; it is a response from a triggered event.
  • You can select as many actions as you want to be taken when the event is triggered.
  • These are the three available actions: Trigger Webhook:trigger webhook
  • Webhooks are automated event-driven messages sent from one system to another.
  • Every time a specified event takes place, the webhook immediately sends a payload to a specified URL. In order to be able to receive the payload, you must add an endpoint.
  • You can customize the approach you want to use from the request method.
  • You can customize webhooks payload using placeholders.

Send SMS/Message:

Applicable when integration is available.
send smsSend Email:
Applicable when email or SMTP integration is available.
send email

  • Each email notification configuration is treated as a template to be used to formulate the final email that is going to be sent.
  • During that process, all placeholders are replaced with the actual values. The available placeholders depend on the kind of event being triggered.
    Placeholders could be used in any of the fields.
    Email bodies could be HTML.

Below is the list of events and the different placeholders available.

Available Placeholders

Placeholders are case-sensitive and have to be enclosed with mustache-pairs/double curly brackets ( {{ ... }} )

Assign plan is requested

  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Customer.FirstJoined}}
  • {{Customer.InfoFields.name}}
  • {{Customer.InfoFields.email}}
  • {{CheckoutUrl}}

Customer is requested to add payment method

  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Customer.FirstJoined}}
  • {{Customer.InfoFields.name}}
  • {{Customer.InfoFields.email}}
  • {{Url}}

Dunning trial is failed

  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Customer.FirstJoined}}
  • {{Customer.InfoFields.name}}
  • {{Customer.InfoFields.email}}
  • {{TrialNumber}}
  • {{TrialAmount}}
  • {{InvoiceId}}
  • {{InvoiceNumber}}
  • {{InvoiceTotal}}

Email is verified

  • {{FirstName}}
  • {{LastName}}
  • {{FullName}}
  • {{EmailAddress}}
  • {{VerificationUrl}}
  • {{VerificationCode}}

Invoice is created

  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Customer.FirstJoined}}
  • {{Customer.InfoFields.name}}
  • {{Customer.InfoFields.email}}
  • {{InvoiceId}}
  • {{InvoiceNumber}}
  • {{Amount}}
  • {{Currency}}
  • {{InvoiceBilledOn}}
  • {{InvoiceDueOn}}
  • {{InvoiceCheckoutUrl}}
  • {{InvoiceAdminUrl}}
  • {{InvoiceStatus}}

Invoice is refunded

  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Customer.FirstJoined}}
  • {{Customer.InfoFields.name}}
  • {{Customer.InfoFields.email}}
  • {{RefundedFromInvoiceId}}
  • {{RefundInvoiceId}}
  • {{Amount}}
  • {{Currency}}
  • {{RefundDate}}

Invoice needs manual payment

  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Customer.FirstJoined}}
  • {{Customer.InfoFields.name}}
  • {{Customer.InfoFields.email}}
  • {{InvoiceId}}
  • {{InvoiceNumber}}
  • {{Amount}}
  • {{Currency}}
  • {{InvoiceBilledOn}}
  • {{InvoiceDueOn}}
  • {{InvoiceCheckoutUrl}}
  • {{InvoiceAdminUrl}}
  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Customer.FirstJoined}}
  • {{Customer.InfoFields.name}}
  • {{Customer.InfoFields.email}}
  • {{InvoiceId}}
  • {{InvoiceUrl}}

Manual payment is requested

  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Customer.FirstJoined}}
  • {{Customer.InfoFields.name}}
  • {{Customer.InfoFields.email}}
  • {{InvoiceId}}
  • {{Amount}}
  • {{Currency}}
  • {{InvoiceUrl}}

New customer portal user is created

  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Password}}

New subscriber is signed up

  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Customer.FirstJoined}}
  • {{Customer.InfoFields.name}}
  • {{Customer.InfoFields.email}}
  • {{Subscription.BillingCycleInfo.Unit}}
  • {{Subscription.BillingCycleInfo.Duration}}
  • {{Subscription.BillingType}}
  • {{Subscription.Id}}
  • {{Subscription.Name}}
  • {{Subscription.PlanCode}}
  • {{Subscription.Pricing.Price}}
  • {{Subscription.PricingModel}}
  • {{Subscription.ProductName}}
  • {{Subscription.Quantity}}
  • {{Subscription.SetupFee}}
  • {{Subscription.Status}}
  • {{Subscription.TrailPeriod.Duration}}
  • {{Subscription.TrailPeriod.Unit}}
  • {{Subscription.SiteId}}

Subscriber’s info is updated

  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Customer.FirstJoined}}
  • {{Customer.InfoFields.name}}
  • {{Customer.InfoFields.email}}

Subscription is cancelled

  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Customer.FirstJoined}}
  • {{Customer.InfoFields.name}}
  • {{Customer.InfoFields.email}}
  • {{Subscription.BillingCycleInfo.Unit}}
  • {{Subscription.BillingCycleInfo.Duration}}
  • {{Subscription.BillingType}}
  • {{Subscription.Id}}
  • {{Subscription.Name}}
  • {{Subscription.PlanCode}}
  • {{Subscription.Pricing.Price}}
  • {{Subscription.PricingModel}}
  • {{Subscription.ProductName}}
  • {{Subscription.Quantity}}
  • {{Subscription.SetupFee}}
  • {{Subscription.Status}}
  • {{Subscription.TrailPeriod.Duration}}
  • {{Subscription.TrailPeriod.Unit}}
  • {{Subscription.SiteId}}

Subscription is paused

  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Customer.FirstJoined}}
  • {{Customer.InfoFields.name}}
  • {{Customer.InfoFields.email}}
  • {{Subscription.BillingCycleInfo.Unit}}
  • {{Subscription.BillingCycleInfo.Duration}}
  • {{Subscription.BillingType}}
  • {{Subscription.Id}}
  • {{Subscription.Name}}
  • {{Subscription.PlanCode}}
  • {{Subscription.Pricing.Price}}
  • {{Subscription.PricingModel}}
  • {{Subscription.ProductName}}
  • {{Subscription.Quantity}}
  • {{Subscription.SetupFee}}
  • {{Subscription.Status}}
  • {{Subscription.TrailPeriod.Duration}}
  • {{Subscription.TrailPeriod.Unit}}
  • {{Subscription.SiteId}}
  • {{ResumeDate}}
  • {{PausingDuration}}
  • {{PausingUnit}}

Subscription is about to renew

  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Customer.FirstJoined}}
  • {{Customer.InfoFields.name}}
  • {{Customer.InfoFields.email}}
  • {{Subscription.BillingCycleInfo.Unit}}
  • {{Subscription.BillingCycleInfo.Duration}}
  • {{Subscription.BillingType}}
  • {{Subscription.Id}}
  • {{Subscription.Name}}
  • {{Subscription.PlanCode}}
  • {{Subscription.Pricing.Price}}
  • {{Subscription.PricingModel}}
  • {{Subscription.ProductName}}
  • {{Subscription.Quantity}}
  • {{Subscription.SetupFee}}
  • {{Subscription.Status}}
  • {{Subscription.TrailPeriod.Duration}}
  • {{Subscription.TrailPeriod.Unit}}
  • {{Subscription.SiteId}}
  • {{RenewSubscriptionDate}}

Subscription is renewed

  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Customer.FirstJoined}}
  • {{Customer.InfoFields.name}}
  • {{Customer.InfoFields.email}}
  • {{Subscription.BillingCycleInfo.Unit}}
  • {{Subscription.BillingCycleInfo.Duration}}
  • {{Subscription.BillingType}}
  • {{Subscription.Id}}
  • {{Subscription.Name}}
  • {{Subscription.PlanCode}}
  • {{Subscription.Pricing.Price}}
  • {{Subscription.PricingModel}}
  • {{Subscription.ProductName}}
  • {{Subscription.Quantity}}
  • {{Subscription.SetupFee}}
  • {{Subscription.Status}}
  • {{Subscription.TrailPeriod.Duration}}
  • {{Subscription.TrailPeriod.Unit}}
  • {{Subscription.SiteId}}

Subscription is resumed

  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Customer.FirstJoined}}
  • {{Customer.InfoFields.name}}
  • {{Customer.InfoFields.email}}
  • {{Subscription.BillingCycleInfo.Unit}}
  • {{Subscription.BillingCycleInfo.Duration}}
  • {{Subscription.BillingType}}
  • {{Subscription.Id}}
  • {{Subscription.Name}}
  • {{Subscription.PlanCode}}
  • {{Subscription.Pricing.Price}}
  • {{Subscription.PricingModel}}
  • {{Subscription.ProductName}}
  • {{Subscription.Quantity}}
  • {{Subscription.SetupFee}}
  • {{Subscription.Status}}
  • {{Subscription.TrailPeriod.Duration}}
  • {{Subscription.TrailPeriod.Unit}}
  • {{Subscription.SiteId}}
  • {{ResumeDate}}

Trial period is about to end

  • {{Customer.CustomerId}}
  • {{Customer.FirstName}}
  • {{Customer.LastName}}
  • {{Customer.Name}}
  • {{Customer.EmailAddress}}
  • {{Customer.FirstJoined}}
  • {{Customer.InfoFields.name}}
  • {{Customer.InfoFields.email}}
  • {{Subscription.BillingCycleInfo.Unit}}
  • {{Subscription.BillingCycleInfo.Duration}}
  • {{Subscription.BillingType}}
  • {{Subscription.Id}}
  • {{Subscription.Name}}
  • {{Subscription.PlanCode}}
  • {{Subscription.Pricing.Price}}
  • {{Subscription.PricingModel}}
  • {{Subscription.ProductName}}
  • {{Subscription.Quantity}}
  • {{Subscription.SetupFee}}
  • {{Subscription.Status}}
  • {{Subscription.TrailPeriod.Duration}}
  • {{Subscription.TrailPeriod.Unit}}
  • {{Subscription.SiteId}}
  • {{TrialPeriodEndDate}}