Webhooks and Push Event Notifications

Webhooks (also known as "Web Callbacks" or "Outbound Push Notifications") are sent by the BluSynergy systems when business events occur. These are typically used to when your applications need to be notified when various billing or payments related events occur. These settings may be configured from the [System >> Integration Settings >> Website Callbacks] menu (see the screenshot below).

For example, let's say you'd like to automatically provision a user account in your application/systems when a new customer is created and you'd like to de-provision/suspend the account if a customer is delinquent. In this case, you'd select the "New Customer Signup" and the "Customer Status Change" events. Now, all subsequent customer signups and customer status changes will cause the BluSynergy system to initiate a Webhook (aka Callback / Push Notification) request to your system.

The payload for all the Webhooks are the exact same XML data as if your application made an inbound API REST call using the HTTP GET method on the relevant object. (click here and then go to the section header)

For example if you are interested in the New Customer webhook, the callback payload will be the same as a HTTP GET request for a customer:  Customer API.

Your application will receive a HTTP POST to the URL you provided, with a querystring parameter named "type" that indicates which type of event was fired. The HTTP HEADER will have 'Content-Type' set to 'text/xml'
https://<YourApplicationUrl>?type=<eventType>

If you have provided a shared secret, then it is sent in a custom HTTP HEADER field called 'X-BluSynergy-Secret'. We strongly recommend that you validate this field to ensure that the request has originated from the BluSynergy systems and is not a spoof. You may also use IP address validation as an additional security measure, please contact support to obtain the current list of IP addresses.

The following event types are defined in the system: