LogiSense Billing supports an eventing system that generates events based on configured triggers in the system such as the addition or cancellation of a package, bucket bill run completion etc. In order and Out of order queuing of events are supported. Subscribers can register for Create, update and delete access to the event queue. LogiSense will provide notification mechanisms that trigger off the underlying event. Two types of notifications will be supported:
Email: sending of a predefined email to one or more system user addresses based on the event trigger
Webhooks: A callout to a customer designated URL based on the event trigger
Parameters (tokens) can be associated with notifications to provide additional information about the event. Note that tokens are contextual and dependent on the underlying notification. For example, on a service state transition notification it is possible to provide the corresponding service name as a token. However, on a bill run it is not possible to provide a service name as there are multiple accounts and services that can be associated with a bill run.
Webhooks
LogiSense supports event-based API call outs to other systems via webhooks. A webhook is a HTTPS POST that occurs when an event fires. All webhooks are authenticated and conform with the HTTPS protocol. The platform will initiate the webhook call over HTTPS to a configurable customer-designated URL. LogiSense will allow the user to specify the path to the receiver service of the callout. The URL must be specified using the HTTP Secure (https://) protocol. The platform will not support custom ports for callouts. Up to 2048 characters will be allowed for the Base URL. Customers can subscribe to the notification events listed below and register webhook call outs based on those events.
Event | Description |
|---|---|
Service State Transition | Triggered on a service state transition (Trial->Active, Active->Suspended …) |
Account Status Change | Triggered when the status of an account changes |
Account Cancellation | Triggered when an account has been cancelled |
Bill Run Started | Triggered when a bill run is initiated |
Bill Run Completed | Triggered when a bill run is completed |
Invoice Posted | Triggered when an invoice has been posted |
Invoice Overdue | Triggered when an invoice has breached its payment terms |
Invoice Delivery | Triggered when an invoice has been delivered |
Invoice Delivery Date + xt | Triggered x days after invoice delivery and at a certain time t. x = days and t = time are configurable |
Refund | Triggered when a refund has been processed on the account |
Credit Processed | Triggered when a credit has been processed on the account |
Payment Processed | Triggered when an automatic payment has successfully been processed |
Payment Processing Error | Triggered when an automatic payment has failed during processing |
Contract Under Commit | Triggered when a contract under commit occurs. This can be done per commit tier. |
Dormant SIM | Triggered when a SIM is dormant (i.e. has no usage associated with it). |
Package Cancellation | Triggered when a package has been cancelled |
Usage Threshold Exceeded | Triggered when a bucket tier has been used up |
Parameters can be added to the call out. Parameters are name value pairs that allow data sources and their values to be added to the callout.
Email Notifications
It is possible to configure SMTP settings for sending of outbound emails. The following SMTP options can be configured:
SMTP Server: the email server to use for outgoing email messages, also known as the Outgoing SMTP Server
SMTP Port: the port to use for outgoing email messages, default is 25
From Name: the name that will appear in the from field
From Address: the email address that will appear in the from address field
SMTP Username: the username used to log in to your SMTP server
SMTP Password: the password used to log in to your SMTP server
Multiple SMTP credentials can be set up per system. Administrators can use this if they need to support multiple email accounts and provide the ability to send certain types of notifications from one account and other types of notifications from a different account.