Finally, the subscription function returns a success code to the user.Unity API instructs its internal Event Filtering System to watch out for subscription related events, so that they can be collected for later retrieval.If the webhook call returns a success code within a certain time period, the subscription function proceeds with the next step.During creation of the new subscription, Unity API checks the validity of the specified webhook URL using an HTTPS POST call.The address of the URL to be called by Unity API is specified when a new subscription of delivery type 'webhook' is created.
The webhook enables "listening" for arriving notifications in your subscription's mailbox and fetching notifications on-demand when they become available instead of having to speculatively query the 'fetch' API at regular intervals. Consuming notifications is still done at your discretion through the same means as with fetch-based subscriptions. Calls to your webhook API endpoint only inform about new notifications and do not contain notification details. Webhook-based subscriptions allow registering an API endpoint under your control to receive HTTPS calls informing about new notifications in the "mailbox" store. The following list of event types are currently supported and can be subscribed to:Ī lightweight request to fetch the latest available notifications that are related to a given subscription. If you are a Webroot eCommerce/distribution partner and want to enable notifications on your assigned Unity API client credentials, please contact your trusted Webroot representative for getting started. Authenticate with Unity API using your notifications-enabled client credentials to get access to near real-time event notifications.The NOTIFICATION API column indicates whether notifications is enabled for a given client ID.Enter the requested information and make sure to answer Yes for the Do you plan to use the event notification API? question.Alternatively, enable notifications on existing client credentials by selecting a client ID and clicking the Edit button.Click the New button to create new client credentials.Then navigate to Settings -> API Access.Log in with your console account at my. and choose a Global Site Manager console.If you have a Webroot Management Console account for managing your Global Site Manager (GSM) consoles, notifications can be enabled with just a few steps by creating new or modifying existing API Access client credentials. Permission to this scope is NOT automatically granted and you need to enable notifications or request access. Future releases will incorporate these features as the Unity API evolves.Įvent notifications functionality is provided as part of API methods which are grouped under the Notifications.Subscriptions API scope. The following subchapters introduce the different aspects of the event notification functionality and provide more detailed information about currently available Event Types, Notification Domains, and Delivery Mechanisms.Īdding support and improvements for additional event types, notification domains and delivery mechanisms is constantly monitored and reviewed by the Unity API and Product teams. This is the purpose of the Unity API Event Notification feature.Įvent Notifications allow you to subscribe to a set of events on different domain levels, and to receive the associated notifications in near real-time. Although ad-hoc information is very useful for presenting the current state of the ecosystem to users on demand, reacting to status change is difficult without being alerted about important state transitions. The Unity API platform enables you to query for a broad set of data relating to Webroot's eCommerce service, endpoint protection product, and global site manager console.
0 kommentar(er)
