Configure HTTP Request Operation for SVS Notifications

SVS (Stored Value Service) notifications for prepaid registers include the following notification type:

• SVS Prepaid Register Low Balance

The email operation uses the SVS Register notification templates. You must have configured and activated at least one of these notification templates before you can configure either an email or HTTP operation. Refer to Notification Templates for more information about these templates.

Complete the following steps to add or edit an HTTP request operation for an SVS notification:

1. Select Setup from Gotransverse application menu .

2. Click Notification Management in the left pane.

   

   Notification Management Window

   Click the icon in the left pane to hide it. Click the icon to open it.

3. In the Service Agreement Notification Actions section, click the name of the notification you want to configure to open the Action Configuration window for that notification.

   

   Service Agreement Notification Actions Section

4. On the Action Configuration window, in the HTTP Request Operations section, click the Add button, or click Edit in the Actions column for that operation to edit the operation. Both actions open the Configure HTTP Request window.

   

   Action Configuration Window

5. On the Configure HTTP Request window, enter the required and relevant information:

   

   Configure HTTP Request Window

   Required fields are marked with an asterisk.

   • Enable Operation checkbox — Indicates whether the operation is on and available for use. Select or deselect the checkbox to enable or disable this action as follows:

     • Selected: The request will occur.

     • Not selected: The request will not occur. This request can be enabled later. Any request operation can be enabled at any time after they are created.

   • Register Balance Status — Select a stored value service prepaid register balance status that triggers the notification. When the customer's register balance moves into the selected status, a notification is triggered. You can set the thresholds using the Gotransverse API when creating a prepaid register type.

     • Green: Register balance is above the top threshold.

     • Yellow: Register balance is between the top threshold and the middle threshold.

     • Orange: Register balance is between the middle threshold and the bottom threshold.

     • Red: Register balance is below the bottom threshold.

   • Register Type — Select the register type that is tracked for this notification. Registers are managed in the Products application. Refer to Register Types Module for more information about managing registers.

   • Billing Account Custom Field — Select from the list of enabled Account Custom Fields. The list also includes the option All to select all enabled Account Custom Fields.

   • Billing Account Custom Field Value — For text custom field types, enter a value that will trigger the notification. For list custom field types, select from a list of options, including All, to trigger the notification.

     If the option All was selected in the Billing Account Custom Field field, this field does not display.

   • Account Category — For multi-entity tenants only. Select the account category from the drop-down list.

   • External Application* — Select an HTTP external application that you configured in External Applications.

   • URL* — Enter the URL of the website to access. Access to an external website is configured in the External Applications module.

   • Http Method* — The type of call this action makes. Select an option from the drop-down list: POST, GET, or DELETE.

   • Content Type* — Enter the provided content type, if needed. You can enter up to 255 characters.

   • Date Format* — Change the provided format if needed.

   • Add New Header Name/Value — Click this button to display two additional fields, which can be used to add extra content to the header.

     If you have added too many Name/Value fields, you can click the Remove Last Header Name/Value button to remove the last set of Name and Value fields.

     • Name*: The header’s name.

     • Value*: The value to be included in the header.

   • Payload: Select items from the Palette on the right to add to the Payload text box.

     You can highlight a palette item and then drag it to the Payload text box.

6. Click Finish to save the request. The HTTP request is added (or updated) in the HTTP Request Operations section of the Action Configuration window.

 

 

 

 

Topic updated: 11/2024.