Configuring Criteria for a Transaction Alert Notification Across Stages
You can configure alert notifications through email or web hooks when the total transactions reaches a particular limit across all stages.
To configure the license alert criteria
1. Expand the menu options icon 
, in the title bar, and select Administration. 2. Select General > Transaction alerts > All stages.
This displays a list of available alert configurations and the corresponding details.
3. Click Add Criteria and provide the following information:
Field | Description |
Notify at | Select the usage percentage at which the notification is to be sent. |
Notify through | The user can be notified through one or both of the following ways by selecting the appropriate options:  Email: Select this option and provide a valid email address to which the license alerts are sent. You can add multiple email addresses by clicking  . Webhook: You have to configure the webhook to invoke a HTTP call back to send the transaction alert notifications. Select this option and provide the following information: URL: Mandatory. Specifies the REST endpoint URL to invoke the HTTP call back to. Username: The username information to be sent through the Authorization header. Password: The username information to be sent through the Authorization header. Header key: The HTTP header key that should be included in the header of API requests Header value: The HTTP header value that should be included in the header of API requests Note: You can add multiple key-value pairs by clicking . |
4. Click Save.
Schema
When you select the webhook to invoke a HTTP callback to send an alert notification the following response payload is sent in the webhook notification.
{
"type": "object",
"properties": {
"notificationSetForPercentage": {
"type": "integer",
"title": "The notification percentage",
"description": "The transaction limit percentage at which notifications
should be generated.",
"examples": [
90
]
},
"totalTransactions": {
"type": "integer",
"title": "The number of transactions allocated",
"description": "The total number of transactions per month allocated
for a particular customer.",
"examples": [
10000000
]
},
"usedTransactions": {
"type": "integer",
"title": "The number of transactions consumed ",
"description": "The total number of transactions consumed presently
by the consumers.",
"examples": [
1000000
]
},
"percentageUsed": {
"type": "integer",
"title": "The percentage of transaction usage ",
"description": "The rate of transaction usage computed as
usedTransactions/totalTransactions.",
"examples": [
10
]
},
"notificationSentDate": {
"type": "integer",
"title": "The date of notification",
"description": "The date (in long value) at which the notification was
generated for the transaction limit consumption.",
"examples": [
1524646797
]
}
},
"required": [
"notificationSetForPercentage",
"totalTransactions",
"usedTransactions",
"percentageUsed",
"notificationSentDate"
]
}
An example of a sample payload schema would look like:
{
"notificationSetForPercentage": 90,
"totalTransactions": 10000000,
"usedTransactions": 1000000,
"percentageUsed": 10,
"notificationSentDate": 1524646797
}