Configuration Parameters for Event Notifications

When you call the /notificationService endpoint using POST or PATCH, you can pass the following configuration parameters in the request body to enable, configure, or update the event notifications:

Event Notifications Configuration Parameters
Property Name	Description
authToken	Authentication token of the webhook endpoints if authType=bearer. Leave empty if authType=none or authType=basic.
authType	Authentication type of the webhook endpoints. Valid values: basic, bearer, and none
basicUserId	User name for basic authentication for the webhook endpoints. The user name and password are passed as a base64-encoded string in the format username:password. Example: Username: revenera_webhook_user Password: cmV2ZW5lcmFfd2ViaG9va191c2Vy Important:basicUserId and basicPassword are used for authentication for the entitlementWebhookUrl, productWebhookUrl, and deviceWebhookUrl properties. The credentials must be the same for all three webhook endpoints.
basicPassword	Password for basic authentication for the webhook endpoints. The user name and password are passed as a base64-encoded string in the format username:password. Important:basicUserId and basicPassword are used for authentication for the entitlementWebhookUrl, productWebhookUrl, and deviceWebhookUrl properties. The credentials must be the same for all three webhook endpoints.
entitlementSubscription	Set to true to subscribe to event notifications for entitlement and line item changes. Possible values: true or false (the value must be enclosed in quotation marks, for example, "true")
entitlementWebhookUrl	Webhook endpoint that receives the information about entitlement and line item events. Example: https://api.dev.central.mycompany.com/revenera-webhook/v1/notifications/entitlements Important:To access the entitlementWebhookUrl, pass authentication information using the properties basicUserId and basicPassword. The credentials must be the same as for productWebhookUrl and deviceWebhookUrl.
fnoServiceUrl	The URL to your FlexNet Operations instance. Depending on your AWS instance, the URL has the following format: http://<siteID>-fno-uat.flexnetoperations.eu/flexnet/operations/ http://<siteID>-fno-uat.flexnetoperations.com/flexnet/operations/ where <siteID> is your organization’s site ID which is supplied by Revenera. This is usually your organization's DNS name, but can also be the tenant ID that was assigned to your organization when FlexNet Operations was first implemented, and would have the format flexNNNN. For production environments, omit "-uat".
fnoServiceUser	Base64-encoded user name of the FlexNet Operations user with the system administrator role.
fnoServiceUserPassword	Base64-encoded password of the FlexNet Operations user with the system administrator role.
productSubscription	Set to true to subscribe to event notifications for product and feature changes. Possible values: true or false (the value must be enclosed in quotation marks, for example, "true")
productWebhookUrl	Webhook endpoint that receives the information about product and feature events. Example: https://api.dev.central.mycompany.com/revenera-webhook/v1/notifications/products Important:To access the productWebhookUrl, pass authentication information using the properties basicUserId and basicPassword. The credentials must be the same as for entitlementWebhookUrl and deviceWebhookUrl.
deviceSubscription	Set to true to subscribe to event notifications for device changes. Possible values: true or false (the value must be enclosed in quotation marks, for example, "true")
deviceWebhookUrl	Webhook endpoint that receives the information about device events. Example: https://api.dev.central.mycompany.com/revenera-webhook/v1/notifications/devices Important:To access the deviceWebhookUrl, pass authentication information using the properties basicUserId and basicPassword. The credentials must be the same as for entitlementWebhookUrl and productWebhookUrl.
activateNotifications	Activates or deactivates all event notifications. Set to true to receive event notifications. Possible values: true or false
siteId	Your site’s ID in the UAT (or Production) environment, supplied by Revenera. The site ID is usually your organization's DNS name, but can also be the tenant ID that was assigned to your organization when FlexNet Operations was first implemented. It usually has the format flexNNNN. For the siteId parameter, omit the “flex” prefix. Example: 12345

Sample Payload

The following shows a sample payload for a product event subscription:

{

"siteId": "{{site-id}}",

"entitlementSubscription": "true",

"productSubscription": "true",

"deviceSubscription": "true",

"entitlementWebhookUrl": "{{webhook-products}}",

"productWebhookUrl": "{{webhook-entitlements}}",

"deviceWebhookUrl": "{{webhook-devices}}",

"authType": "none",

"authToken": null,

"basicUserId": null,

"basicPassword": null,

"fnoServiceUrl": "https://{{fno-url}}/flexnet",

"fnoServiceUser": "{{fno-user-b64}}",

"fnoServiceUserPassword": "{{fno-pwd-b64}}",

"activateNotifications": "true"

}