GET /service/api/notifications/subscriptions
Gets information about the active subscriptions associated with the authenticated caller.
Subscriptions are maintained on the basis of username and client id. Only subscriptions that have been created and are active for the username and client id pair of the caller are returned.
Request Information
URI Parameters
None.
URI Sample(s)
GET
|
https://unityapi.webrootcloudav.com/service/api/notifications/subscriptions
|
Body Parameters
None.
Response Information
Resource Description
List of active subscriptions with information on subscribed domains and event types.
Subscriptions are maintained on the basis of username and client id. Only subscriptions are returned that have been created and are active for the username and client id pair of the caller.
GetSubscriptionsResponseModelName | Description | Type | Additional Information |
---|---|---|---|
Count |
The total number of active subscriptions. |
integer |
None. |
Subscriptions |
List of active subscriptions. |
Collection of SubscriptionResponseModel |
None. |
Sample Response
{ "Count": 2, "Subscriptions": [ { "SubscriptionId": "f783de8e-b070-4ecf-ac8f-081d8a0ae71d", "DeliveryType": "fetch", "Domain": { "Type": "Site", "Values": [ { "Name": "GSMKey", "Value": "4E75-A905-7A2A-420C-B721" }, { "Name": "SiteKey", "Value": "C50B-D064-D0EA-4A21-B7DB" } ] }, "EventTypes": [ "Endpoint.FileDetection" ], "Webhook": null, "CreatedDate": "2024-06-08T01:21:13.5810918Z", "UpdatedDate": "2024-07-08T01:21:13.5810918Z" }, { "SubscriptionId": "309df8f1-f21a-4b2b-94ff-bc77a277f007", "DeliveryType": "webhook", "Domain": { "Type": "Site", "Values": [ { "Name": "GSMKey", "Value": "B1C8-1AC4-BE80-4415-9C40" }, { "Name": "SiteKey", "Value": "F9E6-D042-488C-456B-8446" } ] }, "EventTypes": [ "Endpoint.FileDetection" ], "Webhook": { "DeliveryContext": "MyCustomCorrelationString", "DeliveryRateInSeconds": 90, "DeliveryUrl": "https://my.company.com/wrunity/notifications/webhook", "Suspended": false, "Statistics": null }, "CreatedDate": "2024-06-08T01:21:13.5810918Z", "UpdatedDate": "2024-07-08T01:21:13.5810918Z" } ] }
<GetSubscriptionsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Notifications.Models"> <Count>2</Count> <Subscriptions> <SubscriptionResponseModel> <CreatedDate>2024-06-08T01:21:13.5810918Z</CreatedDate> <DeliveryType>fetch</DeliveryType> <Domain> <Type>Site</Type> <Values> <SubscriptionResponseModelDomainValue> <Name>GSMKey</Name> <Value>4E75-A905-7A2A-420C-B721</Value> </SubscriptionResponseModelDomainValue> <SubscriptionResponseModelDomainValue> <Name>SiteKey</Name> <Value>C50B-D064-D0EA-4A21-B7DB</Value> </SubscriptionResponseModelDomainValue> </Values> </Domain> <EventTypes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>Endpoint.FileDetection</d4p1:string> </EventTypes> <SubscriptionId>f783de8e-b070-4ecf-ac8f-081d8a0ae71d</SubscriptionId> <UpdatedDate>2024-07-08T01:21:13.5810918Z</UpdatedDate> <Webhook i:nil="true" /> </SubscriptionResponseModel> <SubscriptionResponseModel> <CreatedDate>2024-06-08T01:21:13.5810918Z</CreatedDate> <DeliveryType>webhook</DeliveryType> <Domain> <Type>Site</Type> <Values> <SubscriptionResponseModelDomainValue> <Name>GSMKey</Name> <Value>B1C8-1AC4-BE80-4415-9C40</Value> </SubscriptionResponseModelDomainValue> <SubscriptionResponseModelDomainValue> <Name>SiteKey</Name> <Value>F9E6-D042-488C-456B-8446</Value> </SubscriptionResponseModelDomainValue> </Values> </Domain> <EventTypes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>Endpoint.FileDetection</d4p1:string> </EventTypes> <SubscriptionId>309df8f1-f21a-4b2b-94ff-bc77a277f007</SubscriptionId> <UpdatedDate>2024-07-08T01:21:13.5810918Z</UpdatedDate> <Webhook> <DeliveryContext>MyCustomCorrelationString</DeliveryContext> <DeliveryRateInSeconds>90</DeliveryRateInSeconds> <DeliveryUrl>https://my.company.com/wrunity/notifications/webhook</DeliveryUrl> <Statistics i:nil="true" /> <Suspended>false</Suspended> </Webhook> </SubscriptionResponseModel> </Subscriptions> </GetSubscriptionsResponseModel>