GET /service/api/notifications/subscriptions/{subscriptionId}
Gets information about a specific subscription.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| subscriptionId |
The identifier of the subscription to retrieve. |
string |
Required |
URI Sample(s)
|
GET
|
https://unityapi.webrootcloudav.com/service/api/notifications/subscriptions/0fc517dc-3f1f-4e78-b3ac-378ed5c18274
|
Body Parameters
None.
Response Information
Resource Description
Information about a specific subscription with information on the subscribed domain and event types.
GetSubscriptionResponseModel| Name | Description | Type | Additional Information |
|---|---|---|---|
| SubscriptionId |
The subscription identifier. |
string |
None. |
| DeliveryType |
The delivery type of the subscription. |
string |
None. |
| Domain |
The domain the subscription has been created for. |
SubscriptionResponseModelDomain |
None. |
| EventTypes |
The list of subscribed event types. |
Collection of string |
None. |
| Webhook |
Information about webhook properties set for the subscription. This value is null, if DeliveryType is anything other than "webhook". |
SubscriptionResponseModelWebhook |
None. |
| CreatedDate |
The time when the subscription was created. |
date |
None. |
| UpdatedDate |
The time when the subscription was last updated. |
date |
None. |
Sample Response
{
"SubscriptionId": "f037fc3b-807c-451d-bc77-c48add4dbc7e",
"DeliveryType": "fetch",
"Domain": {
"Type": "Site",
"Values": [
{
"Name": "GSMKey",
"Value": "39CA-47B8-1565-4682-9731"
},
{
"Name": "SiteKey",
"Value": "8E1B-EB97-3281-44FC-B313"
}
]
},
"EventTypes": [
"Endpoint.FileDetection"
],
"Webhook": {
"DeliveryContext": "MyCustomCorrelationString",
"DeliveryRateInSeconds": 90,
"DeliveryUrl": "https://my.company.com/wrunity/notifications/webhook",
"Suspended": false,
"Statistics": null
},
"CreatedDate": "2025-11-04T20:51:23.6275121Z",
"UpdatedDate": "2025-12-04T20:51:23.6275121Z"
}
<GetSubscriptionResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Notifications.Models">
<CreatedDate>2025-11-04T20:51:23.6275121Z</CreatedDate>
<DeliveryType>fetch</DeliveryType>
<Domain>
<Type>Site</Type>
<Values>
<SubscriptionResponseModelDomainValue>
<Name>GSMKey</Name>
<Value>39CA-47B8-1565-4682-9731</Value>
</SubscriptionResponseModelDomainValue>
<SubscriptionResponseModelDomainValue>
<Name>SiteKey</Name>
<Value>8E1B-EB97-3281-44FC-B313</Value>
</SubscriptionResponseModelDomainValue>
</Values>
</Domain>
<EventTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>Endpoint.FileDetection</d2p1:string>
</EventTypes>
<SubscriptionId>f037fc3b-807c-451d-bc77-c48add4dbc7e</SubscriptionId>
<UpdatedDate>2025-12-04T20:51:23.6275121Z</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>
</GetSubscriptionResponseModel>