...
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 |
|---|---|
Account Service State Transition | Triggered on a service/subscription 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 |
Account Package Change | Triggered when an account package status changes |
Account Contract Under Commit | Triggered when a contract under commit occurs. This can be done per commit tier. |
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 ProcessedNote | Triggered when a credit note 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 CommitUsage Threshold Exceeded | Triggered when a contract under commit occurs. This can be done per commit tier. |
Package Cancellation | Triggered when a package has been cancelled |
Usage Threshold Exceededbucket tier has been used up | |
Scheduled Report | Triggered when a bucket tier scheduled report has been used upgenerated |
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.
...