Configuration Parameters for Event Notifications
When you call the /notificationService endpoint using GET, POST, or PATCH, you can pass the following configuration parameters in the request body to enable, configure, or update the event notifications:
|
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 and productWebhookUrl properties. The credentials must be the same for both 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 and productWebhookUrl properties. The credentials must be the same for both webhook endpoints. |
|
entitlementSubscription |
Set to true to subscribe to event notifications for entitlement and line item changes. Possible values: true or false |
|
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. |
|
productSubscription |
Set to true to subscribe to event notifications for product and feature changes. Possible values: true or false |
|
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. |
|
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. Example: https://mycompany-uat.flexnetoperations.eu/flexnet/operations/startPage |