You can subscribe to event notifications by following the steps below.
Home > Tech Writers Hub > Knowledge Services Sandbox > Aria Crescendo APIs Bucket > Developer's Guide > Event Notification Use Cases > Event Notifications Archive > Manage Event Notifications > Subscribe to Event Notifications
Subscribe to Event Notifications
Subscribe to Event Notifications
Table of contents
Overview
Subscribing to Event Notifications
Getting Here: Click Configuration > Notifications > Events
- Click the event group that you want to subscribe to.
- Select Yes to enable event notifications for the selected event group.
- Select each event about which you want to receive a notification.
If you sell virtual inventory, you must select the following events in order for Aria to increase the number of units of a virtual inventory that a customer has when these events have been successfully completed:
- Account created (in the Accounts Based event group).
- Order paid event (in the Order Based event group).
- Invoice fully paid (in the Financial Transactions event group).
If you have statements generated for your customers as XML documents, you must subscribe to the Account Message Type "XML Statement" Requires Sending event (in the Account and Master Plan Instances Notifications group) to retrieve the corresponding statement numbers. Please see the Transaction API documentation for more information about using the get_aria_xml_statement API call to retrieve XML statements.
- Click the Step Results tab.
- Select a Method by which you want to receive event notifications.
Note: The SMTP (email) and HTTP methods are not secure and are therefore not recommended. Secure HTTP is the recommended method.
- Specify the Destination for each method. Enter the URL address only. Do not enter a protocol (for example, https://).
- Click for Examples
-
- If the Method is Transaction Resource Synch, enter the Server Name provided to you by Aria.
- If the Method is Transaction Data via Email enter an email address.
- If the Method is Transaction Data via HTTP or Transaction Data via Secure HTTP, enter a server IP address or URL.
- Select Yes for the Status to enable the transmission of event notifications to your specified destination using your specified method.
Note: The Resource Sync method applies only if you sell virtual inventory. This method is available for only the Account and Master Plan Instances Based, Order Based, and Financial Transactions event groups.
- If you selected an HTTP or a Secure HTTP method:
Check the Server Response checkbox, then in the associated field, enter a custom server response message to send to Aria when notifications have been successfully received by your system(s). The default response message is OK.
From the Attempts drop-down, specify the number of times to resend the event notification to your system(s) if the event notification fails. The maximum number of attempts is 9.
Note: The first attempt is included in the count. If the Attempt value is 3, and the initial attempt fails, up to two more attempts are made.
If you specified more than one attempt, then enter the Delay in seconds to indicate how long Aria waits between attempts.
It is recommended that you set the delay to at least 300 seconds. This allows enough time for Aria to attempt another transmission and for your server to send back a response.
- For each additional destination where you want to receive event notifications, click Add another step, then repeat Steps 9-12 as described above.
You can set up a maximum of five event notification steps. Click Remove this step if you want to delete a step.
- Click Save.
Aria sends notifications about your selected events to the destination(s) that you specified and in the order of the steps that you added. You can drag steps to change their order.
Notifications are sent to all step destinations. You cannot specify unique notifications for each step destination.
- © Copyright 2023 Aria Developer Central